Jump to

• Request
• Response

getItemType

get

/ccstore/v1/itemTypes/{id}

Get Item Type. Get item type and base type info.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the item type.

Query Parameters

• includeBase(optional): boolean
  Set to true to get base type details.
• parent(optional): string
  Parent Type of current requested item type. It takes product as default parent for custom types.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getItemType_response

Type: object

Show Source

• displayName(optional): string
  Display name of item type.
• id(optional): string
  ID of item type.
• propertiesOrder(optional): array propertiesOrder
  List of properties in ascending order
• specifications(optional): array specifications
  List of specifications for user-defined item type.

{
    "properties":{
        "propertiesOrder":{
            "description":"List of properties in ascending order",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "description":"Display name of item type.",
            "type":"string"
        },
        "id":{
            "description":"ID of item type.",
            "type":"string"
        },
        "specifications":{
            "description":"List of specifications for user-defined item type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "validationPattern":{
                        "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                        "type":"string"
                    },
                    "readAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                        "type":"string"
                    },
                    "securityMaskingValue":{
                        "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of specification.",
                        "type":"string"
                    },
                    "writeSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether specification is required or not.",
                        "type":"number"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default value of specificaion.",
                        "type":"string"
                    },
                    "textSearchable":{
                        "description":"Whether text is searchable or not.",
                        "type":"boolean"
                    },
                    "writeRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                        "type":"string"
                    },
                    "shopperWritable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "dimension":{
                        "description":"Dimension of specification.",
                        "type":"string"
                    },
                    "editableAttributes":{
                        "description":"List of editable properties",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "readRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                        "type":"string"
                    },
                    "readSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                        "type":"string"
                    },
                    "length":{
                        "description":"Length of type supported.",
                        "type":"boolean"
                    },
                    "shopperReadable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                        "type":"string"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "writeAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                        "type":"string"
                    },
                    "searchable":{
                        "description":"Whether item searchable or not.",
                        "type":"boolean"
                    },
                    "internalOnly":{
                        "description":"Whether specification is internal.",
                        "type":"boolean"
                    },
                    "uiEditorType":{
                        "description":"The UI editor type.",
                        "type":"string"
                    },
                    "localizable":{
                        "description":"Whether specification is localizable or not.",
                        "type":"boolean"
                    },
                    "multiSelect":{
                        "description":"Whether multi-select search facet or not.",
                        "type":"number"
                    }
                }
            }
        }
    }
}

Nested Schema : propertiesOrder

Type: array

List of properties in ascending order

Show Source

• Array of: string

{
    "description":"List of properties in ascending order",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : specifications

Type: array

List of specifications for user-defined item type.

Show Source

• Array of: object items

{
    "description":"List of specifications for user-defined item type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "validationPattern":{
                "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                "type":"string"
            },
            "readAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                "type":"string"
            },
            "securityMaskingValue":{
                "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                "type":"string"
            },
            "type":{
                "description":"Data type of specification.",
                "type":"string"
            },
            "writeSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                "type":"string"
            },
            "required":{
                "description":"Whether specification is required or not.",
                "type":"number"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "default":{
                "description":"Default value of specificaion.",
                "type":"string"
            },
            "textSearchable":{
                "description":"Whether text is searchable or not.",
                "type":"boolean"
            },
            "writeRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                "type":"string"
            },
            "shopperWritable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                "type":"string"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "dimension":{
                "description":"Dimension of specification.",
                "type":"string"
            },
            "editableAttributes":{
                "description":"List of editable properties",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "readRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                "type":"string"
            },
            "readSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                "type":"string"
            },
            "length":{
                "description":"Length of type supported.",
                "type":"boolean"
            },
            "shopperReadable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                "type":"string"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "writeAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                "type":"string"
            },
            "searchable":{
                "description":"Whether item searchable or not.",
                "type":"boolean"
            },
            "internalOnly":{
                "description":"Whether specification is internal.",
                "type":"boolean"
            },
            "uiEditorType":{
                "description":"The UI editor type.",
                "type":"string"
            },
            "localizable":{
                "description":"Whether specification is localizable or not.",
                "type":"boolean"
            },
            "multiSelect":{
                "description":"Whether multi-select search facet or not.",
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default value of specificaion.
• dimension(optional): string
  Dimension of specification.
• editableAttributes(optional): array editableAttributes
  List of editable properties
• id(optional): string
  ID of specification.
• internalOnly(optional): boolean
  Whether specification is internal.
• label(optional): string
  Label for new item type.
• length(optional): boolean
  Length of type supported.
• localizable(optional): boolean
  Whether specification is localizable or not.
• multiSelect(optional): number
  Whether multi-select search facet or not.
• readAccessRight(optional): string
  Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)
• readRole(optional): string
  Can be set to a single role id, in which case a user must have that role in order to read the property.
• readSecurityLevel(optional): string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute. Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error. Deny security is only available on custom properties.
• required(optional): number
  Whether specification is required or not.
• searchable(optional): boolean
  Whether item searchable or not.
• securityMaskingValue(optional): string
  A value to return if the read fails the security check and the readSecurityLevel is ignore.
• shopperReadable(optional): string
  If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.
• shopperWritable(optional): string
  If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile.
• textSearchable(optional): boolean
  Whether text is searchable or not.
• type(optional): string
  Data type of specification.
• uiEditorType(optional): string
  The UI editor type.
• validationPattern(optional): string
  Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
• writable(optional): string
  Whether writable or not.
• writeAccessRight(optional): string
  Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)
• writeRole(optional): string
  Can be set to a single role id, in which case a user must have that role in order to write the property.
• writeSecurityLevel(optional): string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that writes will fail silently. Deny means that attempts to write the property will result in an error.

{
    "type":"object",
    "properties":{
        "validationPattern":{
            "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
            "type":"string"
        },
        "readAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
            "type":"string"
        },
        "securityMaskingValue":{
            "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
            "type":"string"
        },
        "type":{
            "description":"Data type of specification.",
            "type":"string"
        },
        "writeSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
            "type":"string"
        },
        "required":{
            "description":"Whether specification is required or not.",
            "type":"number"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "default":{
            "description":"Default value of specificaion.",
            "type":"string"
        },
        "textSearchable":{
            "description":"Whether text is searchable or not.",
            "type":"boolean"
        },
        "writeRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
            "type":"string"
        },
        "shopperWritable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
            "type":"string"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "dimension":{
            "description":"Dimension of specification.",
            "type":"string"
        },
        "editableAttributes":{
            "description":"List of editable properties",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "readRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
            "type":"string"
        },
        "readSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
            "type":"string"
        },
        "length":{
            "description":"Length of type supported.",
            "type":"boolean"
        },
        "shopperReadable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
            "type":"string"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "writeAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
            "type":"string"
        },
        "searchable":{
            "description":"Whether item searchable or not.",
            "type":"boolean"
        },
        "internalOnly":{
            "description":"Whether specification is internal.",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"The UI editor type.",
            "type":"string"
        },
        "localizable":{
            "description":"Whether specification is localizable or not.",
            "type":"boolean"
        },
        "multiSelect":{
            "description":"Whether multi-select search facet or not.",
            "type":"number"
        }
    }
}

Nested Schema : editableAttributes

Type: array

List of editable properties

Show Source

• Array of: string

{
    "description":"List of editable properties",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "shopperInputs":[
        {
            "uiEditorType":"shortText",
            "values":[
            ],
            "name":"Gift Message",
            "label":"Gift Message",
            "id":"giftMessage",
            "promptText":"Enter the gift message",
            "type":"shortText",
            "required":false
        }
    ],
    "displayName":"Tables",
    "count":10,
    "id":"Tables",
    "specifications":[
        {
            "itemType":"Tables",
            "hidden":false,
            "length":1000,
            "variantBasedDisplay":false,
            "label":"Wood Species",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"woodSpecies",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":10,
            "variantBasedDisplay":false,
            "label":"Seating Capacity",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"seatingCapacity",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":19,
            "variantBasedDisplay":false,
            "label":"Handmade",
            "type":"checkbox",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"handmade",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":1000,
            "variantBasedDisplay":false,
            "label":"Shape",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"shape",
            "order":null
        }
    ],
    "base":[
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Name",
            "type":"shortText",
            "required":true,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"displayName",
            "order":"0"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":165,
            "variantBasedDisplay":false,
            "label":"Product ID",
            "type":"shortText",
            "required":true,
            "writable":false,
            "uiEditorType":null,
            "default":"",
            "listingVariant":false,
            "localizable":false,
            "id":"id",
            "order":"10"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Description",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"description",
            "order":"10"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Brand",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"brand",
            "order":"15"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"List Price",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"listPrices",
            "order":"19"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"Sale Price",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"salePrices",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"Shipping Surcharge",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"shippingSurcharges",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"List Price",
            "type":"currency",
            "required":true,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"listPrice",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"Sale Price",
            "type":"currency",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"salePrice",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"Shipping Surcharge",
            "type":"currency",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"shippingSurcharge",
            "order":"21"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Product Tax Code",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"taxCode",
            "order":"25"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":4000000,
            "variantBasedDisplay":false,
            "label":"Long Description",
            "type":"richText",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"longDescription",
            "order":"30"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":1,
            "variantBasedDisplay":false,
            "label":"Active",
            "type":"checkbox",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"active",
            "order":"50"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":7,
            "variantBasedDisplay":false,
            "label":"Arrival Date",
            "type":"date",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"arrivalDate",
            "order":"60"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Height",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"height",
            "order":"70"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Length",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"length",
            "order":"80"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Width",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"width",
            "order":"90"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Weight",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"weight",
            "order":"100"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":10,
            "variantBasedDisplay":false,
            "label":"Order Limit",
            "type":"digit",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"orderLimit",
            "order":"110"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33013|Could not find item type| |20589|Invalid parent type provided.| |20688|Parent Id does not match Item Type|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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