Jump to

• Request
• Response

Update the status of one e-signature

post

/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/action/updateESignatureStatus

Updates the e-signature status based on the approval process results when the inspection organization is electronic record and electronic signature enabled.

Request

Path Parameters

• IpEventId(required): integer
  Value that uniquely identifies the inspection event.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• eSignatureStatus: string
  E-signature status to apply to the inspection event.
• rootTaskId: string
  Unique identifier of the root human task associated with the e-signature process for an e-records and e-signature transaction.

{
    "type":"object",
    "properties":{
        "rootTaskId":{
            "type":"string",
            "description":"Unique identifier of the root human task associated with the e-signature process for an e-records and e-signature transaction.",
            "nullable":true
        },
        "eSignatureStatus":{
            "type":"string",
            "description":"E-signature status to apply to the inspection event.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The action returns a status and error message indicating whether the e-signature status is updated successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The action returns a status and error message indicating whether the e-signature status is updated successfully."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The action returns a status and error message indicating whether the e-signature status is updated successfully."
}

The action returns a status and error message indicating whether the e-signature status is updated successfully.

Back to Top