External Documents (GET, POST)

Get information about external document details and update.

Resource

1/connect/external-document

Example URI

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0/connect/external-document

Available Version

58.0

Example for GET

You can access the external document details using the reference object such as document template, contract document version or using the external document ID.

Note

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0/connect/external-document?externalDocumentId=${externalDocumentId}

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0/connect/external-document?refObjectId=${refObjectId}

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0/connect/external-document?externalDocumentId=${externalDocumentId}&refObjectId=${refObjectId}

Example for POST

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0/connect/external-document

HTTP Methods

GET, POST

Query Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`externalDocumentId`	String	ID of an external document record.	Required	58.0
`refObjectId`	String	ID for the salesforce reference object.	Required	58.0

Response Body for GET

External Document Output

Request Body for POST

JSON Example

1{
2  "refObjectId": "",
3  "contentversionId": "",
4  "documentNamePrefix": "namespaceprefix",
5  "isAsync": true
6}

Properties

Name	Type	Description	Required or Optional	Available Version
`contentVersionId`	String	Content version ID of the document using which new external document is created.	Required	58.0
`documentNamePrefix`	String	Document name prefix, which is required to name the newly created external document.	Optional	58.0
`isAsync`	String	Determines the way the external document gets created.	Optional	58.0
`refObjectId`	String	ID of the reference object. This can be either a document template or a contract ID.	Optional	58.0

Response Body for POST

External Document Creation Output