Jump to

• Request
• Response

Get all award project certifications

get

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardProjectId(required): integer(int64)
  Unique identifier of the award project.

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
• 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 an award project certification record with the specified certification ID.
    Finder Variables:
    • AwardProjectCertificationId; integer; Identifier of the certification.
• 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:
  

  • ApprovalDate; string; Date when the award project certification was approved.
  • AssuranceNumber; string; Assurance of compliance number. Indicates that the organization complies with the regulations for the protection of animal or human research subjects.
  • AwardId; integer; Unique identifier of the award.
  • AwardProjectCertificationId; integer; Unique identifier of the certification assigned to the award or award project.
  • AwdProjectLnkId; integer; Unique identifier of the award project.
  • CertificationDate; string; Date when the certification for the award project was performed.
  • CertificationId; integer; Unique identifier of the certification.
  • CertificationName; string; Name of the award project certification.
  • CertificationStatus; string; Status of the award project certification.
  • CertifiedBy; integer; Unique identifier of the person certifying the award project certification.
  • CertifiedByPersonName; string; Person certifying the award project certification.
  • Comments; string; Comments for the award project certification.
  • CreatedBy; string; The user that created the award project certification.
  • CreationDate; string; The date when the award project certification was created.
  • ExemptionNumber; string; Number that determines whether the research involves no more than minimal risk and meets criteria specified by federal regulations, and is therefore exempt from protocol approvals.
  • ExpeditedReviewFlag; boolean; Indicates whether the award project certification requires an expedited review.
  • ExpirationDate; string; Date when the award project certification expires.
  • FullReviewFlag; boolean; Indicates if the award project certification requires a full review.
  • LastUpdateDate; string; The date when the award project certification was last updated.
  • LastUpdatedBy; string; The user that last updated the award project certification.
• 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:
  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 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 : awards-AwardProject-AwardProjectCertification

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/awards-AwardProject-AwardProjectCertification-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object awards-AwardProject-AwardProjectCertification-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/awards-AwardProject-AwardProjectCertification-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 : awards-AwardProject-AwardProjectCertification-item-response

Type: object

Show Source

• ApprovalDate: string (date)
  Title: Approval Date

  Date when the award project certification was approved.
• AssuranceNumber: string
  Title: Assurance Number

  Maximum Length: 20

  Assurance of compliance number. Indicates that the organization complies with the regulations for the protection of animal or human research subjects.
• AwardId: integer (int64)
  Title: Award ID

  Unique identifier of the award.
• AwardProjectCertificationId: integer (int64)
  Title: Award Project Certification ID

  Unique identifier of the certification assigned to the award or award project.
• AwdProjectLnkId: integer (int64)
  Title: Award Project Link ID

  Unique identifier of the award project.
• CertificationDate: string (date)
  Title: Certification Date

  Date when the certification for the award project was performed.
• CertificationId: integer (int64)
  Title: Certification ID

  Unique identifier of the certification.
• CertificationName: string
  Title: Certification Name

  Maximum Length: 80

  Name of the award project certification.
• CertificationStatus: string
  Title: Status

  Maximum Length: 10

  Status of the award project certification.
• CertifiedBy: integer (int64)
  Title: Certified By

  Unique identifier of the person certifying the award project certification.
• CertifiedByPersonName: string
  Title: Certified By

  Maximum Length: 240

  Person certifying the award project certification.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comments for the award project certification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the award project certification.
• CreationDate: string (date-time)
  Read Only: true

  The date when the award project certification was created.
• ExemptionNumber: string
  Title: Exemption Number

  Maximum Length: 20

  Number that determines whether the research involves no more than minimal risk and meets criteria specified by federal regulations, and is therefore exempt from protocol approvals.
• ExpeditedReviewFlag: boolean
  Title: Expedited Review

  Maximum Length: 1

  Indicates whether the award project certification requires an expedited review.
• ExpirationDate: string (date)
  Title: Expiration Date

  Date when the award project certification expires.
• FullReviewFlag: boolean
  Title: Full Review

  Maximum Length: 1

  Indicates if the award project certification requires a full review.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the award project certification was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the award project certification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award project certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award project certification was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpeditedReviewFlag":{
            "title":"Expedited Review",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the award project certification requires an expedited review.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award project certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwdProjectLnkId":{
            "title":"Award Project Link ID",
            "type":"integer",
            "description":"Unique identifier of the award project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CertificationDate":{
            "title":"Certification Date",
            "type":"string",
            "description":"Date when the certification for the award project was performed.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CertifiedByPersonName":{
            "title":"Certified By",
            "maxLength":"240",
            "type":"string",
            "description":"Person certifying the award project certification.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the award project certification.",
            "nullable":true,
            "x-queryable":true
        },
        "AssuranceNumber":{
            "title":"Assurance Number",
            "maxLength":"20",
            "type":"string",
            "description":"Assurance of compliance number. Indicates that the organization complies with the regulations for the protection of animal or human research subjects.",
            "nullable":true,
            "x-queryable":true
        },
        "FullReviewFlag":{
            "title":"Full Review",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the award project certification requires a full review.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AwardProjectCertificationId":{
            "title":"Award Project Certification ID",
            "type":"integer",
            "description":"Unique identifier of the certification assigned to the award or award project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"Date when the award project certification was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationId":{
            "title":"Certification ID",
            "type":"integer",
            "description":"Unique identifier of the certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExemptionNumber":{
            "title":"Exemption Number",
            "maxLength":"20",
            "type":"string",
            "description":"Number that determines whether the research involves no more than minimal risk and meets criteria specified by federal regulations, and is therefore exempt from protocol approvals.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationName":{
            "title":"Certification Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the award project certification.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the award project certification expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertifiedBy":{
            "title":"Certified By",
            "type":"integer",
            "description":"Unique identifier of the person certifying the award project certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award project certification was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CertificationStatus":{
            "title":"Status",
            "maxLength":"10",
            "type":"string",
            "description":"Status of the award project certification.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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."
        }
    }
}

Back to Top