Get Obligation Categories List using Admin privilege
Purpose
To get the obligation categories list maintained in Choice Lists using Admin privilege.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/admin/obligationcategories
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to obligation categories
READ - Get obligation categories
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/admin/obligationcategories"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- modifiedTimestring
Represents the time of modification.
- displayNamestring
Represents the name of the obligation category.
- idstring
Represents the unique ID of the obligation category.
- addedByuser(short)
Represents the user who created the obligation category.
- apiNamestring
Represents the name of the obligation category in the API.
- addedTimestring
Represents the time when the obligation category is created.
- modifiedByuser(short)
Represents the last user who modified the obligation category.
Possible Errors
INVALID_URL_PATTERNHTTP 404
Request URL is incorrect
Resolution: Specify a valid request URL. Refer to the Request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have contracts.contracts.READ scope. Create a new client with valid scope. Refer to the Scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read records. Contact your organization administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server.
INVALID_REQUEST_METHODHTTP 400
The HTTP request method is not a valid one.
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
The user does not have sufficient privilege to read module details.
Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.
Sample Response
Copied{
"obligationcategories":
[
{
"modifiedTime": String,
"apiName": String,
"displayName": String,
"addedBy": User(Short)
"addedTime": String
"modifiedBy": User(Short)
"id": String
},
]
}