Get an award certification
get
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification/{AwardCertificationId}
Request
Path Parameters
-
AwardCertificationId(required): integer(int64)
The unique identifier of the award certification.
-
AwardId(required): integer(int64)
Unique identifier of the award.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-AwardCertification-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
The approval date of the Certification. -
AssuranceNumber: string
Title:
Assurance Number
Maximum Length:20
Assurance of compliance number. Indicates whether the organization complies with the regulations for the protection of animal or human research subjects. -
AwardCertificationId: integer
(int64)
The unique identifier of the award certification.
-
AwardId: integer
(int64)
Title:
Award ID
The unique internal identifier of the award. -
CertificationDate: string
(date)
Title:
Certification Date
The date of Certification. -
CertificationId: integer
(int64)
Title:
Certification ID
The unique identifier of certification. -
CertificationName: string
Title:
Certification Name
Maximum Length:80
The name of the Award Certifications. -
CertifiedByPersonId: integer
(int64)
Title:
Certified By
The unique ID of the person who gave the Certification. -
CertifiedByPersonName: string
Title:
Certified By
Maximum Length:240
The name of the person who gave the Certification. -
Comments: string
Title:
Comments
Maximum Length:4000
The Award Certification Comment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award certification. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award certification was created. -
ExemptionNumber: string
Title:
Exemption Number
Maximum Length:20
Number that determines whether the research involves more than minimal risk and meets the criteria specified by federal regulations, and therefore, is exempt from protocol approvals. -
ExpeditedReviewFlag: boolean
Title:
Expedited Review
Maximum Length:1
The Expediated Review indicator of the Certification. -
ExpirationDate: string
(date)
Title:
Expiration Date
The Expiration Date of the Certification. -
FullReviewFlag: boolean
Title:
Full Review
Maximum Length:1
Indicates whether the award certification requires a full review. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award certification was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Status: string
Title:
Status
Maximum Length:80
The status of the Certification.
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.
Examples
The following example shows how to get an award certification 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/300100043712585/child/AwardCertification/300100043492133
Response Body Example
The following shows an example of the response body in JSON format.
{ "AwardCertificationId": 300100043492133, "AwardId": 300100043712585, "CertificationId": 300100040183979, "CertificationName": "Smoke Free Environment", "CertificationDate": "2011-10-10", "CertifiedByPersonId": 300100026354758, "CertifiedByPersonName": "phil Williams", "Status": "Yes", "ApprovalDate": "2011-10-10", "ExpirationDate": null, "ExpeditedReviewFlag": false, "Comments": null, "ExemptionNumber": null, "AssuranceNumber": null, "FullReviewFlag": false, "CreatedBy": "Mark.Williams", "CreationDate": "2014-08-06T23:12:48.084+00:00", "LastUpdatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-06T23:12:51.644+00:00" }