Update an award project keyword
patch
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword/{AwardProjectKeywordId}
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
-
AwardProjectId(required): integer(int64)
Unique identifier of the award project.
-
AwardProjectKeywordId(required): integer(int64)
Unique identifier of the keyword assigned to the award or award project.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
KeywordId: integer
(int64)
Title:
Keyword ID
Unique identifier of the keyword. -
KeywordName: string
Title:
Name
Maximum Length:80
Name of the keyword used to describe and track the subject of the award or award project.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-AwardProject-AwardProjectKeyword-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Unique identifier of the award.
-
AwardProjectKeywordId: integer
(int64)
Title:
Award Project Keyword ID
Unique identifier of the keyword assigned to the award or award project. -
AwardProjectLinkId: integer
(int64)
Unique identifier of the award project.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project keyword. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project keyword was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the keyword associated with the award project. -
KeywordId: integer
(int64)
Title:
Keyword ID
Unique identifier of the keyword. -
KeywordName: string
Title:
Name
Maximum Length:80
Name of the keyword used to describe and track the subject of the award or award project. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project keyword was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project keyword. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.