Get Contract Type Template Fields
Purpose
To get the details of the fields present in the contract type template.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/admin/contracttypes/master-services-agreement/fields
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.meta.READ
Possible Operation Types
READ - Get contract type fields info
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/admin/contracttypes/master-services-agreement/fields"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- metaJSON Object
Represents all the fields in the contract type template.
- metaInputsJSON Array
The array represents input fields required to get the value for that particular field. Currently, all field types support only one input.
- metaTypenumber
Represents whether the field is system or user-defined.
Value Description 1 System Field 3 Custom Field - namestring
Represents the name of the field.
- apiNamestring
Represents the API name of the field.
- dataTypenumber
Represents the data type of the field.
Value Description 1 Boolean 2 Number 3 String 4 Date 5 Index 6 Text 7 Currency 8 Term 9 Percent 10 Phone 11 Email - displayTypenumber
Represents the input field type of the field.
Value Description 1 Text, Number, Currency, Percent, Phone, Email 2 Dropdown 6 Date - displayNamestring
Represents the field's label that will be seen in the generated contract document upon contract creation.
- sequenceNumbernumber
Represents the ordinal number of the field in the template (i.e., the first occurrence).
- addedByJSON Object
Represents the user who created the field.
- addedTimestring
Represents the time the field was created.
- modifiedByJSON Object
Represents the last user who modified the field.
- modifiedTimestring
Represents the last modified time of the field.
- documentFieldsJSON Object
The array represents the field's instances in the contract type template.
- idstring
Represents the ID of the field.
- uniqueIdstring
Represents the unique ID of a field's instance in the template.
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.meta.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[
{
"meta": {
"metaInputs": [
{
"sequenceNumber": 1,
"apiName": "deliverables",
"displayType": 1,
"dataType": 6,
"name": "Deliverables",
}
],
"modifiedTime": "Jul 10, 2021 01:54 AM",
"apiName": "deliverables",
"addedBy": "Kevin Bacon",
"scope": 1,
"name": "Deliverables",
"addedTime": "Jul 10, 2021 01:54 AM",
"metaType": 1,
"modifiedBy": "Elizabeth Shue",
},
"documentFields": [
{
"displayName": "DELIVERABLES",
"id": "596000000088373",
"uniqueId": "1565681214747162"
}
],
"id": "596000000014047"
},{
...
}
]