Update a grants personnel keyword
patch
/fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword/{PersonnelKeywordId}
Request
Path Parameters
-
PersonId(required): integer(int64)
Identifier of the person selected from Human Resources to administer and manage awards.
-
PersonnelKeywordId(required): integer(int64)
Identifier of the keyword associated with the Grants personnel.
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: number
Title:
Keyword
Identifier of the keyword selected from Grants keywords. -
KeywordName: string
Title:
Keyword Name
Maximum Length:80
Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel. -
PersonId: number
Title:
Person Name
Identifier of the person selected from Human Resources to administer and manage awards. -
PersonnelKeywordId: integer
(int64)
Identifier of the keyword associated with the Grants personnel.
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 : grantsPersonnel-GrantsPersonnelKeyword-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Details of the keyword that is used to track the key subject area for the Grants personnel. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Date when the keyword becomes active. -
KeywordId: number
Title:
Keyword
Identifier of the keyword selected from Grants keywords. -
KeywordName: string
Title:
Keyword Name
Maximum Length:80
Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: number
Title:
Person Name
Identifier of the person selected from Human Resources to administer and manage awards. -
PersonnelKeywordId: integer
(int64)
Identifier of the keyword associated with the Grants personnel.
-
ToDate: string
(date)
Title:
To Date
Read Only:true
Date after which the keyword is inactive.
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.