Jump to

• Request
• Response

Integrate DocuSign for the electronic signature process of one purchase order.

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/action/eSign

Initiates and manages the electronic signature process for a purchase order or change order using DocuSign integration. eSign actions include preparing for signature, updating document status, managing signatures, and tracking signature history.

Request

Path Parameters

• draftPurchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• eSignAction: string
  Value that indicates the electronic sign action. Valid values include prepareForSignature, updateDocumentStatus, manageSignature, and signatureHistory. This attribute doesn't have a default value. The prepareForSignature value retrieves a URL from DocuSign to prepare purchase orders or purchase change orders in Pending Signature Preparation status for electronic signature. The updateDocumentStatus value updates the purchase order or purchase change order with the envelope status retrieved from DocuSign. The manageSignature value retrieves a URL from DocuSign to view and manage electronic envelopes for purchase orders or purchase change orders in Sent for Signature status. The signatureHistory value retrieves a URL from DocuSign to access the electronic envelope history of purchase orders or purchase change orders.

{
    "type":"object",
    "properties":{
        "eSignAction":{
            "type":"string",
            "description":"Value that indicates the electronic sign action. Valid values include prepareForSignature, updateDocumentStatus, manageSignature, and signatureHistory. This attribute doesn't have a default value. The prepareForSignature value retrieves a URL from DocuSign to prepare purchase orders or purchase change orders in Pending Signature Preparation status for electronic signature. The updateDocumentStatus value updates the purchase order or purchase change order with the envelope status retrieved from DocuSign. The manageSignature value retrieves a URL from DocuSign to view and manage electronic envelopes for purchase orders or purchase change orders in Sent for Signature status. The signatureHistory value retrieves a URL from DocuSign to access the electronic envelope history of purchase orders or purchase change orders.",
            "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

  If the request is successful, this action returns the DocuSign URLs and/or the envelope status to prepare and manage purchase orders for signature.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"If the request is successful, this action returns the DocuSign URLs and/or the envelope status to prepare and manage purchase orders for signature."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, this action returns the DocuSign URLs and/or the envelope status to prepare and manage purchase orders for signature."
}

If the request is successful, this action returns the DocuSign URLs and/or the envelope status to prepare and manage purchase orders for signature.

Back to Top