Service Guides for ResourceIQ

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

Search for an External Document Reference by Assignment URL

After you have created your external document reference (POST /{custid}/externaldocument) and created an assignment for your external document reference (POST /{custid}/assignment/{objectid}), you can search for your external document reference by assignment url. The request will yield the external document reference(s) for the assignment.

To Search for an External Document Reference by Assignment URL (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The assignment URL.

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument/assignment?url=http://hostname.com

Response

200 OK

{
  "items": [
    {
      "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:21:44.000Z"
    }
  ],
  "totalResults": 1
}


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