Jump to

• Request
• Response

Update an award certification

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• Status: string
  Title: Status

  Maximum Length: 80

  The status of the Certification.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the Certification.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpeditedReviewFlag":{
            "title":"Expedited Review",
            "maxLength":1,
            "type":"boolean",
            "description":"The Expediated Review indicator of the Certification.",
            "nullable":true
        },
        "CertificationDate":{
            "title":"Certification Date",
            "type":"string",
            "description":"The date of Certification.",
            "format":"date",
            "nullable":false
        },
        "CertifiedByPersonName":{
            "title":"Certified By",
            "maxLength":240,
            "type":"string",
            "description":"The name of the person who gave the Certification.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"The Award Certification Comment.",
            "nullable":true
        },
        "AssuranceNumber":{
            "title":"Assurance Number",
            "maxLength":20,
            "type":"string",
            "description":"Assurance of compliance number. Indicates whether the organization complies with the regulations for the protection of animal or human research subjects.",
            "nullable":true
        },
        "FullReviewFlag":{
            "title":"Full Review",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the award certification requires a full review.",
            "nullable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AwardCertificationId":{
            "type":"integer",
            "description":"The unique identifier of the award certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The approval date of the Certification.",
            "format":"date",
            "nullable":true
        },
        "CertificationId":{
            "title":"Certification ID",
            "type":"integer",
            "description":"The unique identifier of certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExemptionNumber":{
            "title":"Exemption Number",
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "CertificationName":{
            "title":"Certification Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the Award Certifications.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The Expiration Date of the Certification.",
            "format":"date",
            "nullable":true
        },
        "CertifiedByPersonId":{
            "title":"Certified By",
            "type":"integer",
            "description":"The unique ID of the person who gave the Certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-AwardCertification-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the award certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the Certification.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award certification was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpeditedReviewFlag":{
            "title":"Expedited Review",
            "maxLength":1,
            "type":"boolean",
            "description":"The Expediated Review indicator of the Certification.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that created the award certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CertificationDate":{
            "title":"Certification Date",
            "type":"string",
            "description":"The date of Certification.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CertifiedByPersonName":{
            "title":"Certified By",
            "maxLength":240,
            "type":"string",
            "description":"The name of the person who gave the Certification.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"The Award Certification Comment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssuranceNumber":{
            "title":"Assurance Number",
            "maxLength":20,
            "type":"string",
            "description":"Assurance of compliance number. Indicates whether 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 whether the award certification requires a full review.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardCertificationId":{
            "type":"integer",
            "description":"The unique identifier of the award certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The approval date of the Certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationId":{
            "title":"Certification ID",
            "type":"integer",
            "description":"The unique identifier of certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExemptionNumber":{
            "title":"Exemption Number",
            "maxLength":20,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationName":{
            "title":"Certification Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the Award Certifications.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The Expiration Date of the Certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertifiedByPersonId":{
            "title":"Certified By",
            "type":"integer",
            "description":"The unique ID of the person who gave the Certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "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 certification was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

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