For the complete documentation index, see llms.txt. This page is also available as Markdown.

Application Permissions

Retrieve application permission

get

Get details of a specific application permission

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Application permission details

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
get/api/v1/application_permissions/{id}/

Update Application Permission

put

Updates an existing Application Permission object.

Authorizations
AuthorizationstringRequired
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
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
put/api/v1/application_permissions/{id}/

Delete Application Permission

delete

Deletes an existing Application Permission object.

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
204

Application Permission Deleted

No content

delete/api/v1/application_permissions/{id}/

No content

Partially Update Application Permission

patch

Partially updates an existing Application Permission object.

Authorizations
AuthorizationstringRequired
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
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
patch/api/v1/application_permissions/{id}/

Retrieve detailed application permission

get

Get detailed information of a specific application permission

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Detailed application permission details

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
applicationintegerOptional

Unique identifier for the related application.

Example: 1
get/api/v1/application_permissions/{id}/detailed/

List application permissions

get

Get a list of all application permissions

Authorizations
AuthorizationstringRequired
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

Filter 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
countintegerOptionalExample: 0
nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

get/api/v1/application_permissions/

Create Application Permission

post

Creates a new Application Permission object.

Authorizations
AuthorizationstringRequired
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
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
post/api/v1/application_permissions/

List application permissions with details

get

Get a list of all application permissions with details

Authorizations
AuthorizationstringRequired
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

Filter 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
countintegerOptionalExample: 0
nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

get/api/v1/application_permissions/detailed
200

List of application permissions with details

List application permission children

get

Get a list of all application permission children

Authorizations
AuthorizationstringRequired
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

Filter by name.

Responses
200

List of application permission children

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerOptional

Primary key for the application permission.

Example: 1
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
get/api/v1/application_permissions/children/

Last updated

Was this helpful?