Secured by Basic_Authentication

HTTP status code 201

Headers

• Location: (string)

  A URL of the created data-feed

  Example:

  Location: https://somewhere.net/resources/123
  

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-feed#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single data feed",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the data feed"
    },
    "description": {
      "type": "string",
      "description": "A comment describing the data feed"
    },
    "feedId": {
      "type": "integer",
      "description": "ID of the data feed"
    },
    "poolingStrategy" : {
      "description": "Strategy to determine the id of the correct pool for this feed to use for its next inputs",
      "enum" : ["NAMED_POOL", "GLOBAL_POOL", "NEW_POOL_FOR_INPUT"]
    } ,
    "poolingCondition" : {
      "description": "Name of the pool used",
      "type" : "string"
    } ,
    "defaultCompositionStrategy" : {
      "description": "The default composition strategy to be used by all pools under this data feed",
      "type" : "string"
    } ,
    "defaultPublicationStrategy" : {
      "description": "The default publication strategy to be used by all pools under this data feed",
      "type" : "string"
    }
  },
  "required": ["name"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-loading-actions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "data-loading-actions",
  "description": "A page containing a collection of data loading actions",
  "type": "array",
  "items": "#/data-loading-action"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-feed#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single data feed",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the data feed"
    },
    "description": {
      "type": "string",
      "description": "A comment describing the data feed"
    },
    "feedId": {
      "type": "integer",
      "description": "ID of the data feed"
    },
    "poolingStrategy" : {
      "description": "Strategy to determine the id of the correct pool for this feed to use for its next inputs",
      "enum" : ["NAMED_POOL", "GLOBAL_POOL", "NEW_POOL_FOR_INPUT"]
    } ,
    "poolingCondition" : {
      "description": "Name of the pool used",
      "type" : "string"
    } ,
    "defaultCompositionStrategy" : {
      "description": "The default composition strategy to be used by all pools under this data feed",
      "type" : "string"
    } ,
    "defaultPublicationStrategy" : {
      "description": "The default publication strategy to be used by all pools under this data feed",
      "type" : "string"
    }
  },
  "required": ["name"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/result#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "Result of deleting items",
  "properties": {
    "numberProcessed": {
      "description": "Number of items that were deleted",
      "type": "integer"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pools#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "pools",
  "description": "A collection of data pools",
  "type": "array",
  "items": "#/pool"
}

Secured by Basic_Authentication

HTTP status code 201

Headers

• Location: (string)

  A URL of the created pool

  Example:

  Location: https://somewhere.net/resources/123
  

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pool#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single data pool",
  "properties": {
    "poolId": {
      "description": "ID of the data pool",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the data pool",
      "type": "string"
    },
    "compositionStrategy": {
      "description": "Name of the composition strategy for the data pool",
      "type": "string"
    },
    "publicationStrategy": {
      "description": "Name of the publication strategy for the data pool",
      "type": "string"
    }
  },
  "required": ["poolName"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pools#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "pools",
  "description": "A collection of data pools",
  "type": "array",
  "items": "#/pool"
}

Secured by Basic_Authentication

HTTP status code 201

Headers

• Location: (string)

  A URL of the created pool

  Example:

  Location: https://somewhere.net/resources/123
  

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pool#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single data pool",
  "properties": {
    "poolId": {
      "description": "ID of the data pool",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the data pool",
      "type": "string"
    },
    "compositionStrategy": {
      "description": "Name of the composition strategy for the data pool",
      "type": "string"
    },
    "publicationStrategy": {
      "description": "Name of the publication strategy for the data pool",
      "type": "string"
    }
  },
  "required": ["poolName"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pool#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single data pool",
  "properties": {
    "poolId": {
      "description": "ID of the data pool",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the data pool",
      "type": "string"
    },
    "compositionStrategy": {
      "description": "Name of the composition strategy for the data pool",
      "type": "string"
    },
    "publicationStrategy": {
      "description": "Name of the publication strategy for the data pool",
      "type": "string"
    }
  },
  "required": ["poolName"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/composition-actions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "composition-actions",
  "description": "A collection of data pool composition actions",
  "type": "array",
  "items": "#/composition"
}

Secured by Basic_Authentication

HTTP status code 201

Headers

• Location: (string)

  A URL of the created composition

  Example:

  Location: https://somewhere.net/resources/123
  

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/composition#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single composition action",
  "type": "object",
  "properties": {
    "actionId": {
      "description": "ID of the composition action",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the pool",
      "type": "string"
    },
    "startTime": {
      "description": "The timestamp for when the Composition action started",
      "type": "datetime"
    },
    "endTime": {
      "description": "The timestamp for when the Composition action ended",
      "type": "datetime"
    },
    "type": {
      "description": "Type of the pool action. Namly COMPOSITION",
      "enum": ["COMPOSITION"]
    },
    "status": {
      "description": "Composition status",
      "enum": ["SUCCESS", "IN_PROGRESS", "FAILURE", "PENDING", "COMPLETE_W_ERRORS"]
    },
    "actionId": {
      "description": "Count of canonical items created during the composition action",
      "type": "integer"
    }
  },
  "required": ["started"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/composition#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single composition action",
  "type": "object",
  "properties": {
    "actionId": {
      "description": "ID of the composition action",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the pool",
      "type": "string"
    },
    "startTime": {
      "description": "The timestamp for when the Composition action started",
      "type": "datetime"
    },
    "endTime": {
      "description": "The timestamp for when the Composition action ended",
      "type": "datetime"
    },
    "type": {
      "description": "Type of the pool action. Namly COMPOSITION",
      "enum": ["COMPOSITION"]
    },
    "status": {
      "description": "Composition status",
      "enum": ["SUCCESS", "IN_PROGRESS", "FAILURE", "PENDING", "COMPLETE_W_ERRORS"]
    },
    "actionId": {
      "description": "Count of canonical items created during the composition action",
      "type": "integer"
    }
  },
  "required": ["started"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/publications#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "composition-actions",
  "description": "A collection of publication actions",
  "type": "array",
  "items": "#/publication"
}

Secured by Basic_Authentication

HTTP status code 201

Headers

• Location: (string)

  A URL of the created publication

  Example:

  Location: https://somewhere.net/resources/123
  

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/publication#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single publication action",
  "type": "object",
  "properties": {
    "actionId": {
      "description": "ID of the publication action",
      "type": "integer"
    },
    "type":{
      "description": "Name of the pool",
      "enum": ["PUBLICATION", "RETRY_ITEMS_PUBLICATION"]
    },
    "poolName": {
      "description": "Name of the pool",
      "type": "string"
    },
    "startTime": {
      "description": "The timestamp for when the Publication started",
      "type": "datetime"
    },
    "endTime": {
      "description": "The timestamp for when the Publication ended",
      "type": "datetime"
    },
    "status": {
      "description": "Publication status",
      "enum": ["SUCCESS", "IN_PROGRESS", "COMPLETE_W_ERRORS", "FAILURE", "PENDING"]
    },
    "targetSystemPublications": {
      "description": "A collection of target system publications",
      "type": "array",
      "items": "#/target-system-publication"
    }
  },
  "required":["targetSystemPublications"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/publication#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single publication action",
  "type": "object",
  "properties": {
    "actionId": {
      "description": "ID of the publication action",
      "type": "integer"
    },
    "type":{
      "description": "Name of the pool",
      "enum": ["PUBLICATION", "RETRY_ITEMS_PUBLICATION"]
    },
    "poolName": {
      "description": "Name of the pool",
      "type": "string"
    },
    "startTime": {
      "description": "The timestamp for when the Publication started",
      "type": "datetime"
    },
    "endTime": {
      "description": "The timestamp for when the Publication ended",
      "type": "datetime"
    },
    "status": {
      "description": "Publication status",
      "enum": ["SUCCESS", "IN_PROGRESS", "COMPLETE_W_ERRORS", "FAILURE", "PENDING"]
    },
    "targetSystemPublications": {
      "description": "A collection of target system publications",
      "type": "array",
      "items": "#/target-system-publication"
    }
  },
  "required":["targetSystemPublications"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/target-system-publications#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "publication-actions",
  "description": "A collection of target system publications",
  "type": "array",
  "items": "#/target-system-publication"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/pool-actions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "composition-actions",
  "description": "A collection of data pool actions",
  "type": "array",
  "items": "#/pool-action"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-items#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "item-type-definitions",
  "description": "A collection of data items",
  "type": "array",
  "items": "#/item-type-definition"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/result#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "Result of deleting items",
  "properties": {
    "numberProcessed": {
      "description": "Number of items that were deleted",
      "type": "integer"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/item-status-counts#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "The status counts of all data types per pool",
  "properties": {
    "rawItemStatusCount": {
       "description": "Status counts for all raw items grouped by pool if the request had a pool specified or the addition of all pools if no pool was specified",
       "type": "raw-item-status-counts"
    },
    "canonicalItemStatusCount": {
       "description": "Status counts for all canonical items grouped by pool if the request had a pool specified or the addition of all pools if no pool was specified",
       "type": "canonical-item-status-counts"
    },
    "canonicalPublicationItemStatusCount": {
       "description": "Status counts for all canonical item publications grouped by pool if the request had a pool specified or the addition of all pools if no pool was specified",
       "type": "canonical-publication-item-status-counts"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/raw-item-status-counts#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "The status counts of all raw items per pool",
  "properties": {
    "poolName": {
      "description": "The name of the pool for the counts, or null if the pool is not specified in the request path",
      "type": "string"
    },
    "ignoredCount": {
      "description": "The number of raw items in IGNORED state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "pendingCount": {
      "description": "The number of raw items in PENDING state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "processedCount": {
      "description": "The number of raw items in PROCESSED state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/canonical-item-status-counts#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "The status counts of all canonical items per pool",
  "properties": {
    "poolName": {
      "description": "The name of the pool for the counts. It will be null if the pool is not specified in the request path.",
      "type": "string"
    },
    "successCount": {
      "description": "The number of canonical items in SUCCESS state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "archivedCount": {
      "description": "The number of canonical items in ARCHIVED state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "errorCount": {
      "description": "The number of canonical items in ERROR state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "deletedCount": {
      "description": "The number of canonical items in DELETED state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/canonical-publication-item-status-counts#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "The status counts of all raw items per pool",
  "properties": {
    "poolName": {
      "description": "The name of the pool for the counts. It will be null if the pool is not specified in the request path.",
      "type": "string"
    },
    "successCount": {
      "description": "The number of canonical-publication items in SUCCESS state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "internalErrorCount": {
      "description": "The number of canonical-publication items set to FAILURE state due to Data Hub for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "externalErrorCount": {
      "description": "The number of canonical-publication items set to FAILURE state due to the target system for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    },
    "ignoredCount": {
      "description": "The number of canonical-publication items in IGNORED state for the pool, or the addition for all the pools if poolName is null",
      "type": "long"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
   "id": "/hybris/datahub/target-systems#",
   "$schema": "http://json-schema.org/draft-04/schema",
   "title": "target-systems",
   "description": "A collection of target systems",
   "type": "array",
   "items": "#/target-system"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/target-system-publications#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "publication-actions",
  "description": "A collection of target system publications",
  "type": "array",
  "items": "#/target-system-publication"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/target-system-publication#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A single target system publication",
  "properties": {
    "publicationId": {
      "description": "ID of the target system publication",
      "type": "integer"
    },
    "startTime" : {
      "required" : false ,
      "type" : "string"
    } ,
    "endTime" : {
      "required" : false ,
      "type" : "string"
    } ,
    "actionId": {
      "description": "ID of the publication action",
      "type": "integer"
    },
    "targetSystemName": {
      "description": "The name of the target system being published to",
      "type": "string"
    },
    "status": {
      "description": "Status of this publication",
      "enum": ["SUCCESS", "IN_PROGRESS", "COMPLETE_W_ERRORS", "FAILURE", "PENDING"]
    },
    "poolName" : {
      "required" : false ,
      "type" : "string"
    },
    "canonicalItemCount" : {
      "required" : false ,
      "type" : "number"
    },
    "internalErrorCount" : {
      "required" : false ,
      "type" : "number"
    },
    "externalErrorCount" : {
      "required" : false ,
      "type" : "number"
    },
    "ignoredCount" : {
      "required" : false ,
      "type" : "number"
    }
  },
  "required": ["targetSystemName"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/errors#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "Collection of errors returned from the target system",
  "type": "array",
  "items": "#/error"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/canonicalItemPublicationStatusItemList#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "Collection of items returned from the target system",
  "type": "array",
  "items": "#/canonicalItemPublicationStatusItem"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-items#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "item-type-definitions",
  "description": "A collection of data items",
  "type": "array",
  "items": "#/item-type-definition"
}

Secured by Basic_Authentication

Secured by Basic_Authentication

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/raw-attribute-definitions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "raw-attribute-definitions",
  "description": "A collection of attribute definitions for a raw item type",
  "type": "array",
  "items": "#/raw-attribute-definition"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/raw-attribute-definition#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "A raw attribute of a given raw item type",
  "properties": {
    "name": {
      "description": "Name of the raw attribute",
      "type": "string"
    },
    "itemType": {
      "description": "Type of raw item",
      "type": "string"
    }
  },
  "required": ["name", "itemType"]
}

Secured by Basic_Authentication

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/item-type#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "Defines an item type extending a given base type",
  "properties": {
    "name": {
      "description": "Name of the item type",
      "type": "string"
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/canonical-attribute-definitions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "canonical-attribute-definitions",
  "description": "A collection of attribute definitions for a canonical item type",
  "type": "array",
  "items": "#/canonical-attribute-definition"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/canonical-attribute-definition#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "description": "Information defining the relationship between a canonical attribute and a raw attribute",
  "properties": {
    "name": {
      "description": "Name of the canonical attribute",
      "type": "string"
    },
    "itemType": {
      "description": "The type of raw item this attribute is part of",
      "type": "string"
    },
    "isCollection": {
      "description": "Specifies if this attribute holds a collection of values",
      "type": "boolean"
    },
    "isPrimaryKey": {
      "description": "Specifies if this attribute is used as a primaryKey",
      "type": "boolean"
    },
    "isSecured": {
      "description": "Specifies if this attribute is secured",
      "type": "boolean"
    },
    "isLocalizable": {
      "description": "Specifies if this attribute is localizable",
      "type": "boolean"
    },
    "type": {
      "description": "Specifies the java type of this attribute",
      "type": "string"
    },
    "transformations": {
      "description": "Specifies the canonical transformations of this attribute",
      "type": "canonicaltransformations"
    }
  },
  "required": ["name", "itemType"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-item#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single data item",
  "type": "object",
  "properties": {
    "type": {
      "description": "Item type",
      "type": "string"
    },
    "dataPool": {
      "description": "name of the data pool",
      "type": "string"
    },
    "id": {
      "description": "Item id",
      "type": "long"
    },
    "itemAttributeDataList": {
      "description": "A collection of attributes about the item",
      "type": "array",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the attribute",
            "type": "string"
          },
          "values": {
            "description": "Values for the attribute. If the attribute is not localized, there should be one value in the collection",
            "type": "array",
            "items": {
              "properties": {
                "isoCode": {
                  "description": "Language of the attribute value",
                  "type": "string"
                },
                "value": {
                  "description": "Value of the given attribute. If the attribute is not a collection, there should be one value in the collection",
                    "type": "array",
                    "items" : "string"
                }
              }
            }
          }
        }
      }
    },
    "links": {
      "description": "A collection of IDs for the item",
      "type": "array",
      "link": {
        "properties": {
          "rel": "Relationship of the association",
          "href": "Link to the representation of the associated resource"
        }
      }
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/data-item#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single data item",
  "type": "object",
  "properties": {
    "type": {
      "description": "Item type",
      "type": "string"
    },
    "dataPool": {
      "description": "name of the data pool",
      "type": "string"
    },
    "id": {
      "description": "Item id",
      "type": "long"
    },
    "itemAttributeDataList": {
      "description": "A collection of attributes about the item",
      "type": "array",
      "items": {
        "properties": {
          "name": {
            "description": "Name of the attribute",
            "type": "string"
          },
          "values": {
            "description": "Values for the attribute. If the attribute is not localized, there should be one value in the collection",
            "type": "array",
            "items": {
              "properties": {
                "isoCode": {
                  "description": "Language of the attribute value",
                  "type": "string"
                },
                "value": {
                  "description": "Value of the given attribute. If the attribute is not a collection, there should be one value in the collection",
                    "type": "array",
                    "items" : "string"
                }
              }
            }
          }
        }
      }
    },
    "links": {
      "description": "A collection of IDs for the item",
      "type": "array",
      "link": {
        "properties": {
          "rel": "Relationship of the association",
          "href": "Link to the representation of the associated resource"
        }
      }
    }
  }
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/composition-actions#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "composition-actions",
  "description": "A collection of data pool composition actions",
  "type": "array",
  "items": "#/composition"
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/composition#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "A single composition action",
  "type": "object",
  "properties": {
    "actionId": {
      "description": "ID of the composition action",
      "type": "integer"
    },
    "poolName": {
      "description": "Name of the pool",
      "type": "string"
    },
    "startTime": {
      "description": "The timestamp for when the Composition action started",
      "type": "datetime"
    },
    "endTime": {
      "description": "The timestamp for when the Composition action ended",
      "type": "datetime"
    },
    "type": {
      "description": "Type of the pool action. Namly COMPOSITION",
      "enum": ["COMPOSITION"]
    },
    "status": {
      "description": "Composition status",
      "enum": ["SUCCESS", "IN_PROGRESS", "FAILURE", "PENDING", "COMPLETE_W_ERRORS"]
    },
    "actionId": {
      "description": "Count of canonical items created during the composition action",
      "type": "integer"
    }
  },
  "required": ["started"]
}

Secured by Basic_Authentication

HTTP status code 200

Body

Type: application/json

Schema:

{
  "id": "/hybris/datahub/errors#",
  "$schema": "http://json-schema.org/draft-04/schema",
  "description": "Collection of errors returned from the target system",
  "type": "array",
  "items": "#/error"
}

Secured by Basic_Authentication

HTTP status code 200

Extension was created successfully

HTTP status code 400

Extension was not created, XML was invalid

Secured by Basic_Authentication

Secured by Basic_Authentication

Secured by Basic_Authentication

Secured by Basic_Authentication

Secured by Basic_Authentication