Jump to

• Request
• Response

getMetadata

get

/ccstore/v1/metadata/{id}

Get Metadata. Get the metadata for an item type

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  ID of the file.

Query Parameters

• dynamicOnly: boolean
  Indicates what type of properties to return. If set to true, only dynamic properties will be returned, otherwise all properties will be returned. Only supported for the 'order' item type.
• filterByShopperContext: string
  If set to true, filters the dynamic properties that are related to shopper context

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getMetadata_response

Type: object

Show Source

• default: boolean
  The default property of the metadata
• dimension: string
  The dimension property of the metadata
• id: string
  The id of the metadata
• itemType: string
  The itemtype property of the metadata
• label: string
  The label property of the metadata
• length: integer
  The length of the metadata
• multiSelect: boolean
  The multi-select property of the metadata
• order: integer
  The order of the metadata
• required: boolean
  The required property of the metadata
• searchable: boolean
  The searchable property of the metadata
• textSearchable: boolean
  The textSearchable property of the metadata
• type: string
  The type property of the metadata
• uiEditorType: string
  The uiEditorType property of the metadata

{
    "properties":{
        "itemType":{
            "description":"The itemtype property of the metadata",
            "type":"string"
        },
        "length":{
            "description":"The length of the metadata",
            "type":"integer"
        },
        "label":{
            "description":"The label property of the metadata",
            "type":"string"
        },
        "type":{
            "description":"The type property of the metadata",
            "type":"string"
        },
        "required":{
            "description":"The required property of the metadata",
            "type":"boolean"
        },
        "searchable":{
            "description":"The searchable property of the metadata",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"The uiEditorType property of the metadata",
            "type":"string"
        },
        "default":{
            "description":"The default property of the metadata",
            "type":"boolean"
        },
        "textSearchable":{
            "description":"The textSearchable property of the metadata",
            "type":"boolean"
        },
        "id":{
            "description":"The id of the metadata",
            "type":"string"
        },
        "dimension":{
            "description":"The dimension property of the metadata",
            "type":"string"
        },
        "multiSelect":{
            "description":"The multi-select property of the metadata",
            "type":"boolean"
        },
        "order":{
            "description":"The order of the metadata",
            "type":"integer"
        }
    }
}

Example Response (application/json)

[
    {
        "itemType":"product",
        "length":"254",
        "label":"Name",
        "type":"shortText",
        "required":true,
        "searchable":true,
        "uiEditorType":null,
        "default":null,
        "textSearchable":true,
        "id":"displayName",
        "dimension":null,
        "multiSelect":true,
        "order":"0"
    },
    {
        "itemType":"product",
        "length":"165",
        "label":"Product ID",
        "type":"shortText",
        "required":true,
        "searchable":null,
        "uiEditorType":null,
        "default":"",
        "textSearchable":null,
        "id":"id",
        "dimension":null,
        "multiSelect":null,
        "order":"10"
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top