Service Guides for ResourceIQ

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

Update an External Document Reference

After you have created your external document reference (POST /{custid}/externaldocument), you can update your external document reference. An external document reference is defined by an external document reference object. The data elements related to the external document reference can be updated. The request will yield the updated external document object, any errors and a success flag.

To Update an External Document Reference (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The external document id for the external document reference that you would like to update.
  • The updated external document object.

Request

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

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


Response

200 OK

{
  "updatedExternalDocument": {
    "extensionObject": {
      "id": "50b4fa0d-a5cf-4ecb-92fd-58ac4c5800bc",
      "customerId": "123355",
      "status": "active",
      "objectType": "external_document",
      "objectDescription": "This is an external document object. Updated"
    },
    "externalDocument": {
      "externalDocumentType": "Sample type",
      "fileFormat": "application/zip",
      "notes": "Sample notes",
      "url": "http://ebsco.com"
    },
    "dateCreated": "2019-01-17T20:14:34.000Z",
    "dateLastUpdated": "2019-01-17T20:14:34.000Z"
  },
  "errors": [],
  "successful": true
}


For more information on the PUT update external document reference by id resource, please refer to our interactive or service reference documentation.