Jump to

• Request
• Response
• Examples

Get all grants personnel

get

/fscmRestApi/resources/11.13.18.05/grantsPersonnel

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a grants personnel with the specified primary key.
    Finder Variables:
    • PersonId; integer; Identifier of the person selected from Human Resources to administer and manage awards.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActivePerson; string; Indicates if the person has an active primary assignment in Human Resources as of the current date.
  • CertifiedDate; string; Date when the person completed the conflict of interest review. Enter a start date in this format: YYYY-MM-DD.
  • EligiblePiFlag; boolean; 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; 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.
  • JobName; string; Job assigned to the primary assignment of the person in Human Resources.
  • OrganizationName; string; Organization assigned to the primary assignment of the person in Human Resources.
  • PersonId; integer; Identifier of the person selected from Human Resources to administer and manage awards.
  • PersonName; string; 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; 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; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : grantsPersonnel

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{ "required":[ "count", "hasMore", "limit", "links", "offset" ], "type":"object", "properties":{ "totalResults":{ "type":"integer", "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included." }, "offset":{ "type":"integer", "description":"The offset value used in the current page." }, "count":{ "type":"integer", "description":"The number of resource instances returned in the current range." }, "hasMore":{ "type":"boolean", "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false." }, "limit":{ "type":"integer", "description":"The actual paging size used by the server." }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "items":{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-item-response" } } }, "x-hints":{ "usage":"BusinessObject" } }

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object grantsPersonnel-item-response

{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-item-response" } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : grantsPersonnel-item-response

Type: object

Show Source

• 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
  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.

{ "type":"object", "properties":{ "OrganizationName":{ "title":"Department", "maxLength":240, "type":"string", "description":"Organization assigned to the primary assignment of the person in Human Resources.", "nullable":false, "readOnly":true, "x-queryable":true }, "PersonNumber":{ "maxLength":30, "type":"string", "description":"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.", "nullable":false, "x-queryable":true }, "PersonName":{ "maxLength":255, "type":"string", "description":"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.", "nullable":true, "x-queryable":true }, "GrantsPersonnelDFF":{ "title":"Grants Personnel Descriptive Flexfields", "type":"array", "description":"A listing of all the descriptive flexfields available for Grants personnel.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-GrantsPersonnelDFF-item-response" }, "x-cardinality":"1" }, "CertifiedDate":{ "title":"Certified Date", "type":"string", "description":"Date when the person completed the conflict of interest review. Enter a start date in this format: YYYY-MM-DD.", "format":"date", "nullable":true, "x-queryable":true }, "JobName":{ "title":"Job", "maxLength":240, "type":"string", "description":"Job assigned to the primary assignment of the person in Human Resources.", "nullable":true, "readOnly":true, "x-queryable":true }, "ReviewCompleted":{ "title":"Review Completed", "maxLength":10, "type":"string", "description":"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.", "nullable":true, "x-queryable":true }, "EmailAddress":{ "maxLength":255, "type":"string", "description":"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.", "nullable":true, "x-queryable":true }, "GrantsPersonnelKeyword":{ "title":"Grants Personnel Keywords", "type":"array", "description":"The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-GrantsPersonnelKeyword-item-response" } }, "PersonId":{ "title":"Person Name", "type":"integer", "description":"Identifier of the person selected from Human Resources to administer and manage awards.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "ActivePerson":{ "title":"Active Person", "maxLength":255, "type":"string", "description":"Indicates if the person has an active primary assignment in Human Resources as of the current date.", "nullable":true, "readOnly":true, "x-hints":{ "dependencies":[ "PersonNameEffectiveEndDate", "PersonNameEffectiveStartDate" ] }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "EligiblePiFlag":{ "title":"Principal Investigator", "maxLength":1, "type":"boolean", "description":"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.", "nullable":true, "x-queryable":true } } }

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

• Array of: object grantsPersonnel-GrantsPersonnelDFF-item-response

{ "title":"Grants Personnel Descriptive Flexfields", "type":"array", "description":"A listing of all the descriptive flexfields available for Grants personnel.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-GrantsPersonnelDFF-item-response" }, "x-cardinality":"1" }

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

• Array of: object grantsPersonnel-GrantsPersonnelKeyword-item-response

{ "title":"Grants Personnel Keywords", "type":"array", "description":"The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel.", "items":{ "$ref":"#/components/schemas/grantsPersonnel-GrantsPersonnelKeyword-item-response" } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : grantsPersonnel-GrantsPersonnelDFF-item-response

Type: object

Show Source

• __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.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PersonId":{ "title":"Person Name", "type":"integer", "description":"Identifier of the person selected from Human Resources to administer and manage awards.", "format":"int64", "nullable":false, "x-hints":{ "DISPLAYHINT":"Hide", "includeInCompactView":true, "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "__FLEX_Context_DisplayValue":{ "title":"Context Segment", "type":"string", "description":"Context display value of the descriptive flexfield.", "nullable":true, "x-hints":{ "updateable":"false", "DISPLAYHINT":"Hide", "FND_ACFF_IsReadOnly":"true", "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_ListDisplayAttrName":"Name", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true }, "__FLEX_Context":{ "title":"Context Segment", "maxLength":30, "type":"string", "description":"Context of the descriptive flexfield.", "nullable":true, "x-hints":{ "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT", "controlType":"choice", "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue", "includeInCompactView":true, "FND_ACFF_IsDiscriminator":"true", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : link

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Nested Schema : grantsPersonnel-GrantsPersonnelKeyword-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "Description":{ "title":"Description", "maxLength":240, "type":"string", "description":"Details of the keyword that is used to track the key subject area for the Grants personnel.", "nullable":true, "readOnly":true, "x-queryable":true }, "KeywordId":{ "title":"Keyword", "type":"number", "description":"Identifier of the keyword selected from Grants keywords.", "nullable":false, "x-queryable":true }, "PersonId":{ "title":"Person Name", "type":"number", "description":"Identifier of the person selected from Human Resources to administer and manage awards.", "nullable":false, "x-queryable":true }, "KeywordName":{ "title":"Keyword Name", "maxLength":80, "type":"string", "description":"Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel.", "nullable":false, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "FromDate":{ "title":"From Date", "type":"string", "description":"Date when the keyword becomes active.", "format":"date", "nullable":false, "readOnly":true, "x-queryable":true }, "ToDate":{ "title":"To Date", "type":"string", "description":"Date after which the keyword is inactive.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "PersonnelKeywordId":{ "type":"integer", "description":"Identifier of the keyword associated with the Grants personnel.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Back to Top

Examples

The following example shows how to get all grants personnel by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047724327/child/grantsPersonnel

Response Body Example

The following shows an example of the response body in JSON format of all the grants personnel..

{ "items": [ { "PersonId": 300100031721179, "EligiblePiFlag": null, "CertifiedDate": null, "OrganizationName": "Vision City Maintenance", "JobName": "Consultant", "PersonName": "Mark Williams", "EmailAddress": "[e-mail]", "PersonNumber": "955160008176607", "ActivePerson": "Y", "ReviewCompleted": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179", "name": "grantsPersonnel", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179", "name": "grantsPersonnel", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179/lov/PersonNameDPVO", "name": "PersonNameDPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179/lov/PersonDPVO", "name": "PersonDPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179/lov/PersonEmailPVO", "name": "PersonEmailPVO", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179/child/GrantsPersonnelKeyword", "name": "GrantsPersonnelKeyword", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/grantsPersonnel/300100031721179/child/GrantsPersonnelDFF", "name": "GrantsPersonnelDFF", "kind": "collection" } ], } ... }

Back to Top