Update a grants personnel
patch
/fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}
Request
Path Parameters
-
PersonId(required): integer(int64)
Identifier of the person selected from Human Resources to administer and manage awards.
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
-
CertifiedDate: string
(date)
Title:
Certified Date
Date when the person completed the conflict of interest review. Enter a start date in this format: YYYY-MM-DD. -
EligiblePiFlag: boolean
Title:
Principal Investigator
Maximum Length:1
Indicates whether the person is qualified to be a principal investigator, the person primarily responsible for research. List of accepted values are True or False. -
EmailAddress: string
Maximum Length:
255
Email of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. -
GrantsPersonnelDFF: array
Grants Personnel Descriptive Flexfields
Title:
Grants Personnel Descriptive Flexfields
A listing of all the descriptive flexfields available for Grants personnel. -
GrantsPersonnelKeyword: array
Grants Personnel Keywords
Title:
Grants Personnel Keywords
The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel. -
PersonName: string
Maximum Length:
255
Name of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. -
ReviewCompleted: string
Title:
Review Completed
Maximum Length:10
Indicates whether a conflict of interest exists according to the institution policy and whether the person has completed the review. List of accepted values are True or False.
Nested Schema : Grants Personnel Descriptive Flexfields
Type:
array
Title:
Grants Personnel Descriptive Flexfields
A listing of all the descriptive flexfields available for Grants personnel.
Show Source
Nested Schema : Grants Personnel Keywords
Type:
array
Title:
Grants Personnel Keywords
The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
PersonId: integer
(int64)
Title:
Person Name
Identifier of the person selected from Human Resources to administer and manage awards.
Nested Schema : grantsPersonnel-GrantsPersonnelKeyword-item-patch-request
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-item-response
Type:
Show Source
object
-
ActivePerson: string
Title:
Active Person
Read Only:true
Maximum Length:255
Indicates if the person has an active primary assignment in Human Resources as of the current date. -
CertifiedDate: string
(date)
Title:
Certified Date
Date when the person completed the conflict of interest review. Enter a start date in this format: YYYY-MM-DD. -
EligiblePiFlag: boolean
Title:
Principal Investigator
Maximum Length:1
Indicates whether the person is qualified to be a principal investigator, the person primarily responsible for research. List of accepted values are True or False. -
EmailAddress: string
Maximum Length:
255
Email of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. -
GrantsPersonnelDFF: array
Grants Personnel Descriptive Flexfields
Title:
Grants Personnel Descriptive Flexfields
A listing of all the descriptive flexfields available for Grants personnel. -
GrantsPersonnelKeyword: array
Grants Personnel Keywords
Title:
Grants Personnel Keywords
The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Job assigned to the primary assignment of the person in Human Resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Department
Read Only:true
Maximum Length:240
Organization assigned to the primary assignment of the person in Human Resources. -
PersonId: integer
(int64)
Title:
Person Name
Identifier of the person selected from Human Resources to administer and manage awards. -
PersonName: string
Maximum Length:
255
Name of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Number of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. -
ReviewCompleted: string
Title:
Review Completed
Maximum Length:10
Indicates whether a conflict of interest exists according to the institution policy and whether the person has completed the review. List of accepted values are True or False.
Nested Schema : Grants Personnel Descriptive Flexfields
Type:
array
Title:
Grants Personnel Descriptive Flexfields
A listing of all the descriptive flexfields available for Grants personnel.
Show Source
Nested Schema : Grants Personnel Keywords
Type:
array
Title:
Grants Personnel Keywords
The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : grantsPersonnel-GrantsPersonnelDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person Name
Identifier of the person selected from Human Resources to administer and manage awards.
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.
Nested 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
Links
- GrantsPersonnelDFF
-
Parameters:
- PersonId:
$request.path.PersonId
A listing of all the descriptive flexfields available for Grants personnel. - PersonId:
- GrantsPersonnelKeyword
-
Operation: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeywordParameters:
- PersonId:
$request.path.PersonId
The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel. - PersonId: