Skip to main content
English (US) Nederlands

Elvis 6 REST API - Metadata report

  • Updated

Info: This feature requires Elvis 6.45 or higher.

GET/POST 

http://yourserver.com/metadata/<reportname>.csv?assetPath=<folderPath|containerPath|assetPath>&fields=field1,field2,field3
http://yuorserver.com/metadata/<reportname>.json?assetIds=assetId1,assetId2,assetId3
http://yourserver.com/metadata/assetname.ext.metadata.json?assetIds=assetId&fields=field1,field2

Note: The working of the API was improved in Elvis 6.47. The main part of this article describes the working of the API for Elvis 6.47 and higher. The working of the API for Elvis 6.45 and 6.46 is described at the end of this article.

What does it do?

Creates an overview of metadata fields and their values of one or more assets.

Parameters

assetIds

Comma-separated list of asset IDs. Either assetIds or assetPath must be specified.

Optional.
assetPath

assetPath of the asset, folder, or Container (a Dossier or Collection).

Either assetIds or assetPath must be specified.

In case of a folder or Container, the report is generated for the assets that the folder or Container contains.

Optional.
fields

Comma-separated list of metadata fields to include in the report. If not specified, all fields are included.

Optional.

Errors

Bad Request 400 Occurs when incorrect parameters or a combination of incorrect parameters are specified.
Not Found 404 Occurs when the specified value of assetIds or the assetPath is incorrect.

Examples

Note: The following examples apply to creating a report for single assets.

Example 1

Request

GET

http://localhost:8080/metadata/report.json?assetIds=633_adVi45yBorT7pmS7Lw&fields=assetPath,assetCreated,tags

Result: a downloaded report in json format with the following content:

[{"assetCreated":{"value":1582726693230,"formatted":"2020-02-26 14:18:13 +0000"},"assetPath":"/A/IMG_6124 (1).HEIC","tags":[]}]

Example 2

Request

GET

http://localhost:8080/metadata/report.csv?assetIds=633_adVi45yBorT7pmS7Lw,90bf5LUM4t888YEq2vuED-

Result: a downloaded report in csv format with the following content:

widthPt,assetCreator,mimeType,assetModified,resolution, ... ,versionNumber,widthMm,width,fileType,heightMm
2880.0,woodwing,image/jpg,2020-04-22 13:46:12 +0000,72 px/inch, ... ,2,1016.0,2880,jpeg,635.0
1600.0,woodwing,image/jpg,2020-04-20 17:21:13 +0000,72 px/inch, ... ,1,815.0,1600,jpeg,635.0

Description for Elvis 6.45 and Elvis 6.46

ClosedShow me

What does it do?

Creates an overview of metadata fields and their values of one or more assets.

Parameters

assetIds

Comma-separated list of asset IDs. Either assetIds or assetPath must be specified.

Optional.
assetPath

assetPath of the asset, folder, or Container (a Dossier or Collection).

Either assetIds or assetPath must be specified.

In case of a folder or Container, the report is generated for the assets that the folder or Container contains.

Optional.
format

File format in which the report is generated. Possible formats:

  • json (default)
  • csv

Optional.
fields

Comma-separated list of metadata fields to include in the report. If not specified, all fields are included.

Optional.
stream

Defines if a temporary file is created on the server. Possible values:

  • true (default, recommended). A ZIP file is generated and downloaded without the creation of a temporary file on the server. This allows the download to start immediately but prevents the Web browser from providing a download progress because the total size of the ZIP file is not known when the download starts.
  • false. A ZIP file is created in a temporary directory and not downloaded until all reports are generated. The user can experience some delay in the downloading process.

Optional.
compressionLevel

The compression level of the ZIP file.

Possible values: from 0 to 9. A higher value is better; the default value is 5.

Optional.
max

The maximum number of metadata reports that a ZIP file can include.

Default is 1000.

Optional.

Errors

Bad Request 400 Occurs when incorrect parameters or a combination of incorrect parameters are specified.
Not Found 404 Occurs when the specified value of assetIds or the assetPath is incorrect.

Examples

Note: The following examples apply to creating a report for single assets.

Example 1

Request

GET

http://localhost:8080/metadata/report.json?assetIds=633_adVi45yBorT7pmS7Lw&format=json&fields=assetPath,assetCreated,tags

Result: a downloaded report in json format with the following content:

{"assetCreated":{"value":1582726693230,"formatted":"2020-02-26 14:18:13 +0000"},"assetPath":"/A/IMG_6124 (1).HEIC","tags":[]}

Example 2

Request

GET

http://localhost:8080/metadata/report.csv?assetIds=633_adVi45yBorT7pmS7Lw&format=csv

Result: a downloaded report in csv format with the following content:

gpsLongitude,4.81171388888889
widthPt,3024.0
software,13.3
...
fileType,HEIC
focalLength,4.25
heightMm,1422.3999999999999

Document history

  • 28 April 2020: Added the working of the API for Elvis 6.47 and higher.
  • 28 April 2020: Moved the working of the API for Elvis 6.45 and 6.46 to a separate section.

Related articles

Comment

Do you have corrections or additional information about this article? Leave a comment!
Do you have a question about what is described in this article? Please contact Support.


2 comments

Date Votes
  • Craig Cardillo

    It is not documented here, but on the Assets 6.52 release notes page ( https://helpcenter.woodwing.com/hc/en-us/articles/360043596071#assets-server-6.52.1 ) it is mentioned that you can also create a metadata report of assets that match a query using the 'q' parameter. Unfortunately, it does not seem to support the 'num' parameter, so you cannot limit the report to n number of matches like you can with a search.

    0
  • Maarten van Kleinwee

    Hi Craig,

    Thank you for your feedback.

    The feature that you are referring to is indeed not documented here in the documentation for Elvis, but as part of Assets Server.

    Regarding the support for the 'num' parameter, I have created a ticket for our Support Team who will process this for you.

    Best regards,

    Maarten van Kleinwee
    Senior Technical Writer, WoodWing Software

    0

Please sign in to leave a comment.