Resource Permissions

Article summary

Did you find this summary helpful?

Thank you for your feedback

1. Manage Resource Permissions

This POST method is used to manage resource permissions.

POST	{{url}}/api/resource-manager/permissions

Request Example

curl --location --request POST '{{url}/api/resource-manager/permissions' \
--header 'Authorization: TOKEN {{token}}' \
--data-raw '
{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}'

Response Example

Status: 201 Created

{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

2. Get All Resource Permissions for resource Id

This GET method is used to retrieve a list of all resource permissions

GET	{{url}}/api/resource-manager/resource-types/{resourceTypeId}/permissions

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
resourceTypeId	Resource type of permission ID.	String	Mandatory
searchText	Filter profiles by searching text.	String	Optional

Request Example

curl --location -g --request GET '{{url}}/api/resource-manager/resource-types/{resourceTypeId}/permissions' \
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 200 OK

{
  "count": 0,
  "page": 0,
  "size": 0,
  "sort": "string",
  "data": [
    {
      "permissionId": "string",
      "name": "string",
      "resourceTypeName": "string",
      "isDraft": false,
      "createdOn": "string",
      "versionCount": 0,
      "version": "string"
    }
  ]
}

3. Get Resource Permission by ID

This GET method is used to get resource permissions specified by ID.

GET	{{url}}/api/resource-manager/permissions/{id}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
id	Resource permission ID.	String	Mandatory

Request Example

curl --location -g --request GET '{{url}}/api/resource-manager/permissions/{id}' \
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 200 OK

[
  {
    "permissionId": "string",
    "name": "string",
    "version": "string",
    "createdOn": "string",
    "isDraft": false
  }
]

4. Update Resource Permission

The PUT method allows you to update resource permission.

PUT	{{url}}/api/resource-manager/permissions/{id}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
id	ID of the resource permission to partially update.	String	Mandatory

Request Example

curl --location --request PUT '{{url}}/api/resource-manager/permissions/{id}' \
--header 'Authorization: TOKEN {{token}}' \
--data-raw '{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}'

Response Example

Status: 200 OK

{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

5. Delete Resource Permission

The DELETE method allows you to delete the resource permission.

DELETE

{{url}}/api/resource-manager/permissions/{id}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
id	ID of the resource permission to delete.	String	Mandatory

Request Example

curl --location --request DELETE '{{url}}/api/resource-manager/permissions/{id}' \
--header 'Authorization: TOKEN {{token}}'

Response Example

The resource permission is deleted.

Status: 204 No Content

6. Get Permission for given Version ID

This GET method is used to retrieve the permissions for a specified version.

GET	{{url}}/api/resource-manager/permissions/{id}/{version}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
id	Resource permission ID.	String	Mandatory
version	Version id of the resource permission to get.	String	Mandatory

Request Example

curl --location --request GET '{{url}}/api/resource-manager/permissions/{id}/{version}?' \
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 200 OK

{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

7. Delete Resource Permission

The DELETE method allows you to delete resource permission for a specified version.

DELETE

{{url}}/api/resource-manager/permissions/{id}/{version}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
Id	ID of the resource permission to delete	String	Mandatory
version	ID of the resource permission version to delete	String	Mandatory

Request Example

curl --location --request DELETE '{/api/resource-manager/permissions/{id}/{version}' \
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 204 No Content

8. Get pre signed URLs for checkin/checkout

This GET method retrieves a list of pre signed URLs for checkin/checkout.

GET	{{url}}/api/resource-manager/permissions/get-urls/{id}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
Id	ID of the resource permission to get URLs for.	String	Mandatory

Request Example

curl --location --request GET 'api/resource-manager/permissions/get-urls/{id}' \
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 200 OK

{
  "permissionId": "string",
  "name": "string",
  "version": "string",
  "resourceTypeId": "string",
  "resourceTypeName": "string",
  "description": "string",
  "checkinURL": "string",
  "checkoutURL": "string",
  "checkinFileName": "string",
  "checkinTimeLimit": 0,
  "checkoutTimeLimit": 0,
  "checkoutFileName": "string",
  "isDraft": false,
  "variables": [
    "string"
  ],
  "responseTemplate": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

Was this article helpful?

What's Next

Resource Labels

Table of contents

1. Manage Resource Permissions
2. Get All Resource Permissions for resource Id
3. Get Resource Permission by ID
4. Update Resource Permission
5. Delete Resource Permission
6. Get Permission for given Version ID
7. Delete Resource Permission
8. Get pre signed URLs for checkin/checkout