Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Create an External Document Reference

The create external document reference endpoint allows you to capture a link to an external document such as a contract or license agreement.

To Create an External Document Reference (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • Define the external document reference details payload. More information on the elements in the external document reference details payload can be found in the ExternalDocumentPayload definition.

Request

POST https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument
Body Request Parameter

{
  "extensionObject": {
    "objectDescription": "This is an external document object.",
    "objectType": "external_document",
    "status": "active"
  },
  "externalDocument": {
    "externalDocumentType": "Sample type",
    "fileFormat": "application/zip",
    "notes": "Sample notes",
    "url": "http://ebsco.com"
  }
}

Response

201 CREATED

{
  "externalDocumentId": "50b4fa0d-a5cf-4ecb-92fd-58ac4c5800bc",
  "errors": [],
  "successful": true
}

For more information on the POST create an external document reference resource, please refer to our interactive or service reference documentation.