Contracts | Contract Type
Service to manage entities of type 'ContractType'.
Overview
| URL | api/{tenantKey}/{orgKey}/contractsCore/contractTypes |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET ContractTypes (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See ContractTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ContractType by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See ContractTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET ContractType by key
Returns the entity record that matches the specified key.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
Response:
| When successful, the response body contains the entity record. See ContractTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST ContractTypes
Creates a new entity record.
The following elements are required:
| contractTypeResource | (ApiContractTypeResource) The request body should contain the entity record that should be created. See ApiContractTypeResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiContractTypeResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ContractTypeKey ContractType
Updates the value of attribute 'ContractTypeKey' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description ContractType
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive ContractType
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsDefault ContractType
Updates the value of attribute 'IsDefault' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Remarks ContractType
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Custom Attribute ContractType
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| contractTypeKey | (string) Contract Type |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE ContractType by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE ContractType by key
Deletes the entity record that matches the specified key.
The following elements are required:
| contractTypeKey | (string) Contract Type. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiContractTypeResource
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| description | (string) Description. |
The following elements are optional:
| isDefault | (bool) Is Default. |
| remarks | (string) Remarks. |
ContractTypeResource
The following elements are required:
| contractTypeKey | (string) Contract Type. |
| description | (string) Description. |
The following elements are optional:
| isDefault | (bool) Is Default. |
| remarks | (string) Remarks. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |