A message for our valued customers and partners: This site is retiring, including accounts and API keys, as we migrate to the new developer portal. If you use existing API keys you will be contacted with further migration instructions. Accounts and API keys are not shared between this developer portal and the new developer portal. We recommend you review the new portal's Get Started guide for details on registering a new developer account and requesting new API keys.

getAllByKey

get

getAllByKey

Retrieve one or many contents' metadata

Resource URL

https://test-apis.us-east-1.lmig.com/v1/nebula /{stack}/{tenant}/content-metadata

Query Parameters

Name Description
searchBy
(required)

Key(s) for the search as a json object. The values can be a string or an array. At least one key is required. Example 1 - {"primaryKey": "123456", "secondaryKey": "H3221216423311", "tertiaryKey": "12121212112"}; Example 2 - {"primaryKey":["9898989898","H3221216423311"],"secondaryKey":"12","H3221216423311"]}

dateFrom

Start date to filter search in UTC date format YYYY-MM-DDThh:mm:ssZ. Uses document date. Example, 2019-04-21T13:15:30Z

dateTo

End date to filter search in UTC date format YYYY-MM-DDThh:mm:ssZ. Uses document date. Example, 2019-04-25T13:15:30Z

sortByDate

Sort by document date in the ascending or descending order.

filterBy

Filter by metadata. Takes a json string as name:value pairs where value is an array. Example - {"clientname": ["CASUALTY"], "locationname": ["DOVER", "FENTON", "MIAMI"], "mimeType":["image/tiff","application/pdf"]}

includeRenditions

indicates whether renditions should be retrieved and included in the search response. Rendition urls returned will be S3 URLs as stored in the system and will not be temporary pre-signed usable urls. Set this flag to true for all renditions including thumbnails. Filter the response for type "thumbnail" if only thumbnails are required.

includeNonVisible

Indicates whether documents that are marked as non-visible such as on hold or suppressed are included in the search response. This will not include the documents marked for deletion. By default, documents that have a value in the visibilityIndicator field in the Nebula system will not be returned.

Header Parameters

Name Description
Authorization
(required)

Apigee OAuth2 Bearer Token

UserToken
(required)

JWT used for document access control

RequestingApplication

API Key of the registered client application or application name provided by the Nebula team.

RequestTrackingId

Unique Id used to track the request end-to-end. Required for troubleshooting.

Request Body

Definitions


Name Type Description

Responses

Code Examples

Resource Summary

Security

Content Type

application/octet-stream

Category

Metadata

Schema:

HTTP Code Description

400

Unable to search for documents due to invalid or insufficient data provided by the client

403

Client is not permitted to use this operation

500

Internal server error

Working...