Jump to

• Request
• Response

Read the Metadata of a Given Archived Item.

get

/content/management/api/v1.1/archive/items/{id}/metadata

Read the Metadata of a given archived item. The EXIF metadata will return data sorted ascending by handle'. There is no pagination or query support and the number of items returned can be limited by the server.

Request

Path Parameters

• id: string
  id of the item.

Query Parameters

• expand(optional): string
  Expand parameter provides the option of getting the child resource inline with the item's response. This currently accepts exif,transcripts.When the expand parameter contains an unpermitted field, the resource produces HTTP 400.
  Example : expand=exif
  Returns fully expanded EXIF data for this item.
• fields(optional): string
  This parameter is used to control the returned fields in item metadata. This currently accepts exif,transcripts.The field name is case-sensitive, users must provide the correct field name in the query. When the fields parameter contains an unpermitted field, the resource produces HTTP 400.
  
  Example: fields=exif
  This returns the exif link field
• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ItemMetadataInfo

Type: object

ItemMetadataInfo

Show Source

• exif(optional): object EXIFMetadata
  EXIF Metadata
• links(optional): array links
  Links
• transcripts(optional): object VideoTranscriptMetadata
  Video Transcription Metadata

{
    "type":"object",
    "properties":{
        "exif":{
            "$ref":"#/definitions/EXIFMetadata"
        },
        "transcripts":{
            "$ref":"#/definitions/VideoTranscriptMetadata"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemMetadataInfo"
}

Nested 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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/ItemExtractedExifBean"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"EXIF Metadata"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : VideoTranscriptMetadata

Type: object

Video Transcription 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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Video Transcription Metadata"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object ItemExtractedExifBean
  ItemExtractedExifBean

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/ItemExtractedExifBean"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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).

{
    "type":"object",
    "properties":{
        "rawId":{
            "type":"string",
            "description":"The ID of the EXIF field. Uniquely identifies one EXIF field."
        },
        "handle":{
            "type":"string",
            "description":"The handle or EXIF field name. This value is not translatable."
        },
        "rawValue":{
            "type":"string",
            "description":"The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value."
        },
        "value":{
            "type":"string",
            "description":"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)."
        },
        "type":{
            "type":"string",
            "description":"The data type of the EXIF field. (date, integer, float, string)."
        },
        "stringValue":{
            "type":"string",
            "description":"The text value of the EXIF field. This value will be a text representation of the EXIF field value."
        },
        "integerValue":{
            "type":"integer",
            "format":"int32",
            "description":"The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point."
        },
        "floatValue":{
            "type":"number",
            "format":"float",
            "description":"The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemExtractedExifBean"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object Videotranscript
  Video transcript

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Videotranscript"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : Videotranscript

Type: object

Video transcript

Show Source

• end(optional): string
  End of each transcript node.
• id(optional): string
  Id of each transcript node.
• links(optional): array links
  Links
• start(optional): string
  Start of each transcript node.
• text(optional): string
  Text of each transcript node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top