Read a type of metadata of an Archived Item
get
/content/management/api/v1.1/archive/items/{id}/metadata/{metadataType}
Read a type of metadata of a given archived item.
Request
Path Parameters
-
id: string
id of the item.
-
metadataType: string
type of the metadata. This currently accepts exif,transcripts.
Query Parameters
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
Order by results.Default Value:
handle:asc
-
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : EXIFMetadata
Type:
object
EXIF Metadata
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : ItemExtractedExifBean
Type:
object
ItemExtractedExifBean
Show Source
-
floatValue(optional):
number(float)
The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
-
handle(optional):
string
The handle or EXIF field name. This value is not translatable.
-
integerValue(optional):
integer(int32)
The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
-
links(optional):
array links
Links
-
rawId(optional):
string
The ID of the EXIF field. Uniquely identifies one EXIF field.
-
rawValue(optional):
string
The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
-
stringValue(optional):
string
The text value of the EXIF field. This value will be a text representation of the EXIF field value.
-
type(optional):
string
The data type of the EXIF field. (date, integer, float, string).
-
value(optional):
string
The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.