Create an award term
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms
Request
Path Parameters
- AwardId(required): integer(int64) Unique identifier of the award.
Header Parameters
- Metadata-Context: string If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: string The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- Upsert-Mode: string Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object
- AwardId: integer (int64) Title:
Award ID
The unique identifier of Award. - AwardTermsId: integer (int64) The unique identifier of Award Terms and Conditions.
- Description: string Title:
Description
Maximum Length:240
Award Terms and Conditions description. - TermsCategoryId: integer (int64) The unique identifier of Term and Conditions Category.
- TermsCategoryName: string Title:
Terms and Conditions Category
Maximum Length:80
The terms and Conditions Category name. - TermsId: integer (int64) Title:
Term ID
Unique identifier of Terms and Conditions. - TermsName: string Title:
Terms and Conditions Name
Maximum Length:80
Terms and Conditions Name. - TermsOperator: string Title:
Operator
Maximum Length:40
Terms and Conditions Operator. - TermsValue: string Title:
Value
Maximum Length:20
Terms and Conditions Term value.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
- Metadata-Context: If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : awards-AwardTerms-item-response
Type:
Show Source object
- AwardId: integer (int64) Title:
Award ID
The unique identifier of Award. - AwardTermsId: integer (int64) The unique identifier of Award Terms and Conditions.
- CreatedBy: string Read Only:
true
Maximum Length:64
The user that created the award terms. - CreationDate: string (date-time) Read Only:
true
The date when the award terms was created. - Description: string Title:
Description
Maximum Length:240
Award Terms and Conditions description. - LastUpdateDate: string (date-time) Read Only:
true
The date when the award term was last updated. - LastUpdatedBy: string Read Only:
true
Maximum Length:64
The user that last updated the award terms. - links: array Links Title:
Links
The link relations associated with the resource instance. - TermsCategoryId: integer (int64) The unique identifier of Term and Conditions Category.
- TermsCategoryName: string Title:
Terms and Conditions Category
Maximum Length:80
The terms and Conditions Category name. - TermsId: integer (int64) Title:
Term ID
Unique identifier of Terms and Conditions. - TermsName: string Title:
Terms and Conditions Name
Maximum Length:80
Terms and Conditions Name. - TermsOperator: string Title:
Operator
Maximum Length:40
Terms and Conditions Operator. - TermsValue: string Title:
Value
Maximum Length:20
Terms and Conditions Term value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object
- href: string Title:
hyperlink reference
The URI to the related resource. - kind: string Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. - name: string Title:
name
The name of the link to the related resource. - properties: object properties
- rel: string Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object
- changeIndicator: string Change indicator or the ETag value of the resource instance.