ApplicationPermissions

Retrieve application permission

get

Get details of a specific application permission

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Application permission details

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/application_permissions/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:23:46.380Z",
  "modified_date": "2025-05-22T09:23:46.380Z"
}

Update Application Permission

put

Updates an existing Application Permission object.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

namestringOptional

The name of the application permission.

Example: Instore application permission for store staff

pathstringOptional

The path of the application permission.

Example: /test/path

labelstringOptional

The label of the application permission.

Example: update

parentintegerOptional

Unique identifier for the parent application permission.

Example: 2

applicationintegerOptional

Unique identifier for the related application.

Example: 1

Responses

200

Application Permission Updated

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/application_permissions/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}

{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:23:46.380Z",
  "modified_date": "2025-05-22T09:23:46.380Z"
}

Delete Application Permission

delete

Deletes an existing Application Permission object.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Application Permission Deleted

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/application_permissions/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially Update Application Permission

patch

Partially updates an existing Application Permission object.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

namestringOptional

The name of the application permission.

Example: Instore application permission for store staff

pathstringOptional

The path of the application permission.

Example: /test/path

labelstringOptional

The label of the application permission.

Example: update

parentintegerOptional

Unique identifier for the parent application permission.

Example: 2

applicationintegerOptional

Unique identifier for the related application.

Example: 1

Responses

200

Application Permission Partially Updated

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/application_permissions/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}

{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:23:46.380Z",
  "modified_date": "2025-05-22T09:23:46.380Z"
}

Retrieve detailed application permission

get

Get detailed information of a specific application permission

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed application permission details

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/application_permissions/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": {
    "pk": 1,
    "name": "Instore application permission for store staff",
    "path": "/test/path",
    "label": "update",
    "parent": 2,
    "application": 1,
    "created_date": "2025-05-22T09:23:46.380Z",
    "modified_date": "2025-05-22T09:23:46.380Z"
  },
  "application": 1,
  "created_date": "2025-05-22T09:23:46.380Z",
  "modified_date": "2025-05-22T09:23:46.380Z"
}

List application permissions

get

Get a list of all application permissions

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

namestringOptional

Filters by name

applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color

Responses

200

List of application permissions

application/json

403

Forbidden

get

HTTPcURLJavaScriptPython

GET /api/v1/application_permissions/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T09:23:46.380Z",
      "modified_date": "2025-05-22T09:23:46.380Z"
    }
  ]
}

Create Application Permission

post

Creates a new Application Permission object.

Authorizations

Body

namestringOptional

The name of the application permission.

Example: Instore application permission for store staff

pathstringOptional

The path of the application permission.

Example: /test/path

labelstringOptional

The label of the application permission.

Example: update

parentintegerOptional

Unique identifier for the parent application permission.

Example: 2

applicationintegerOptional

Unique identifier for the related application.

Example: 1

Responses

201

Application Permission Created

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/application_permissions/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}

{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:23:46.380Z",
  "modified_date": "2025-05-22T09:23:46.380Z"
}

List application permissions with details

get

Get a list of all application permissions with details

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

namestringOptional

Filters by name

applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color

Responses

200

List of application permissions with details

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/application_permissions/detailed HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

List of application permissions with details

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T09:23:46.380Z",
      "modified_date": "2025-05-22T09:23:46.380Z"
    }
  ]
}

List application permission children

get

Get a list of all application permission children

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color

namestringOptional

Filters by name

Responses

200

List of application permission children

application/json

403

Forbidden

get

HTTPcURLJavaScriptPython

GET /api/v1/application_permissions/children/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "name": "Instore application permission for store staff",
    "path": "/test/path",
    "label": "update",
    "parent": 2,
    "application": 1,
    "created_date": "2025-05-22T09:23:46.380Z",
    "modified_date": "2025-05-22T09:23:46.380Z"
  }
]