Jump to

• Request
• Response
• Examples

Create collections

post

/fscmRestApi/resources/11.13.18.05/dataCollections

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CatalogNameList: string
  Maximum Length: 1000

  List of catalogs in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CollectionType: integer
  Type of data collection. Includes one of the following values. 1: targeted, 2: net change, or 3: automatic selection. You can use lookup MSC_DATA_COLLECTION_MODE to determine the values that this attribute uses.
• ConversionRateTypeList: string
  Maximum Length: 1000

  List of currency conversion types that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CountryCodeList: string
  Maximum Length: 1000

  List of country codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CreatedBy: string
  Maximum Length: 64

  User who started the data collection process.
• CreationDate: string (date-time)
  Date when the user started the data collection process.
• CustomerClassCodeList: string
  Maximum Length: 1000

  List of customer class codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• EndTime: string (date-time)
  Time when the data collection process ended.
• EntitiesExpected: number
  Total count of entities that the collection process expects to process.
• EntitiesProcessed: number
  Count of entities that the collection process successfully processed.
• EntityList: string
  Maximum Length: 4000

  List of codes for each entity that the user selected in the template for data collection. A comma ( , ) separates each value.
• ESSCollectionJobId: integer (int64)
  Value that uniquely identifies the parent scheduled process for data collection.
• InstanceId: integer
  Value that uniquely identifies the system where the collection process collected entities.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the collection process.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the collection process.
• Message: string
  Text of the error message that occurred during data collection.
• OrderTypeList: string
  Maximum Length: 1000

  List of sales order types that the collection process uses when collecting demand history. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• OrgIdList: string
  Maximum Length: 4000

  List of organizations that the user selected in the template or enabled for the source system. A comma ( , ) separates each value.
• PimOrgIdList: string
  Maximum Length: 4000

  List of organizations in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• PriceList: string
  Maximum Length: 1000

  List of price lists that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• ProcPhase: string
  Maximum Length: 32

  Status of the data collection process. Includes one of the following values: CycleProcessingStart, Pull_Processing, Pull_Done, Load_Processing, Load_Done, Completed, or Purge_Processing.
• RefreshNumber: integer (int64)
  Number that uniquely identifies the time that the collection process most recently collected data.
• SalesOrgHierarchy: string
  Maximum Length: 1000

  Name of the sales organization hierarchy that the collection process collects.
• SourceSystem: string
  Name of the source system where the collection process collected entities.
• StartTime: string (date-time)
  Time when the data collection process started.
• Status: string
  Maximum Length: 32

  Completion status of the collections process. Includes one of the following values: NORMAL, FAILED, or WARNING.
• TemplateName: string
  Template that contains the entities and filters that the user selected for data collection.

{
    "type":"object",
    "properties":{
        "OrgIdList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of organizations that the user selected in the template or enabled for the source system. A comma ( , ) separates each value.",
            "nullable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user started the data collection process.",
            "format":"date-time",
            "nullable":false
        },
        "EndTime":{
            "type":"string",
            "description":"Time when the data collection process ended.",
            "format":"date-time",
            "nullable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message that occurred during data collection.",
            "nullable":true
        },
        "CustomerClassCodeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of customer class codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "EntitiesProcessed":{
            "type":"number",
            "description":"Count of entities that the collection process successfully processed.",
            "nullable":true
        },
        "CountryCodeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of country codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "CollectionType":{
            "type":"integer",
            "description":"Type of data collection. Includes one of the following values. 1: targeted, 2: net change, or 3: automatic selection. You can use lookup MSC_DATA_COLLECTION_MODE to determine the values that this attribute uses.",
            "nullable":true
        },
        "TemplateName":{
            "type":"string",
            "description":"Template that contains the entities and filters that the user selected for data collection.",
            "nullable":true
        },
        "PimOrgIdList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of organizations in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "ESSCollectionJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent scheduled process for data collection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderTypeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of sales order types that the collection process uses when collecting demand history. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "PriceList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of price lists that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "Status":{
            "maxLength":32,
            "type":"string",
            "description":"Completion status of the collections process. Includes one of the following values: NORMAL, FAILED, or WARNING.",
            "nullable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the collection process.",
            "nullable":false
        },
        "ProcPhase":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the data collection process. Includes one of the following values: CycleProcessingStart, Pull_Processing, Pull_Done, Load_Processing, Load_Done, Completed, or Purge_Processing.",
            "nullable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who started the data collection process.",
            "nullable":false
        },
        "InstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the system where the collection process collected entities.",
            "nullable":false
        },
        "StartTime":{
            "type":"string",
            "description":"Time when the data collection process started.",
            "format":"date-time",
            "nullable":true
        },
        "EntityList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of codes for each entity that the user selected in the template for data collection. A comma ( , ) separates each value.",
            "nullable":true
        },
        "RefreshNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the time that the collection process most recently collected data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntitiesExpected":{
            "type":"number",
            "description":"Total count of entities that the collection process expects to process.",
            "nullable":true
        },
        "CatalogNameList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of catalogs in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        },
        "SalesOrgHierarchy":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of the sales organization hierarchy that the collection process collects.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source system where the collection process collected entities.",
            "nullable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the collection process.",
            "format":"date-time",
            "nullable":false
        },
        "ConversionRateTypeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of currency conversion types that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : dataCollections-item-response

Type: object

Show Source

• CatalogNameList: string
  Maximum Length: 1000

  List of catalogs in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CollectionType: integer
  Type of data collection. Includes one of the following values. 1: targeted, 2: net change, or 3: automatic selection. You can use lookup MSC_DATA_COLLECTION_MODE to determine the values that this attribute uses.
• ConversionRateTypeList: string
  Maximum Length: 1000

  List of currency conversion types that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CountryCodeList: string
  Maximum Length: 1000

  List of country codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• CreatedBy: string
  Maximum Length: 64

  User who started the data collection process.
• CreationDate: string (date-time)
  Date when the user started the data collection process.
• CustomerClassCodeList: string
  Maximum Length: 1000

  List of customer class codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• EndTime: string (date-time)
  Time when the data collection process ended.
• EntitiesExpected: number
  Total count of entities that the collection process expects to process.
• EntitiesProcessed: number
  Count of entities that the collection process successfully processed.
• EntityList: string
  Maximum Length: 4000

  List of codes for each entity that the user selected in the template for data collection. A comma ( , ) separates each value.
• ESSCollectionJobId: integer (int64)
  Value that uniquely identifies the parent scheduled process for data collection.
• ESSCreateTreesJobId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent scheduled process for data collection.
• ESSFlatfileLoadJobId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent flat file load process.
• InstanceId: integer
  Value that uniquely identifies the system where the collection process collected entities.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the collection process.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the collection process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Text of the error message that occurred during data collection.
• OrderTypeList: string
  Maximum Length: 1000

  List of sales order types that the collection process uses when collecting demand history. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• OrgIdList: string
  Maximum Length: 4000

  List of organizations that the user selected in the template or enabled for the source system. A comma ( , ) separates each value.
• PimOrgIdList: string
  Maximum Length: 4000

  List of organizations in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• PriceList: string
  Maximum Length: 1000

  List of price lists that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.
• ProcPhase: string
  Maximum Length: 32

  Status of the data collection process. Includes one of the following values: CycleProcessingStart, Pull_Processing, Pull_Done, Load_Processing, Load_Done, Completed, or Purge_Processing.
• RefreshNumber: integer (int64)
  Number that uniquely identifies the time that the collection process most recently collected data.
• SalesOrgHierarchy: string
  Maximum Length: 1000

  Name of the sales organization hierarchy that the collection process collects.
• SourceSystem: string
  Name of the source system where the collection process collected entities.
• StartTime: string (date-time)
  Time when the data collection process started.
• Status: string
  Maximum Length: 32

  Completion status of the collections process. Includes one of the following values: NORMAL, FAILED, or WARNING.
• TemplateName: string
  Template that contains the entities and filters that the user selected for data collection.

{
    "type":"object",
    "properties":{
        "OrgIdList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of organizations that the user selected in the template or enabled for the source system. A comma ( , ) separates each value.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user started the data collection process.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Time when the data collection process ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message that occurred during data collection.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerClassCodeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of customer class codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitiesProcessed":{
            "type":"number",
            "description":"Count of entities that the collection process successfully processed.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSCreateTreesJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent scheduled process for data collection.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CountryCodeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of country codes that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "CollectionType":{
            "type":"integer",
            "description":"Type of data collection. Includes one of the following values. 1: targeted, 2: net change, or 3: automatic selection. You can use lookup MSC_DATA_COLLECTION_MODE to determine the values that this attribute uses.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateName":{
            "type":"string",
            "description":"Template that contains the entities and filters that the user selected for data collection.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PimOrgIdList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of organizations in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSCollectionJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent scheduled process for data collection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderTypeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of sales order types that the collection process uses when collecting demand history. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of price lists that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":32,
            "type":"string",
            "description":"Completion status of the collections process. Includes one of the following values: NORMAL, FAILED, or WARNING.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the collection process.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcPhase":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the data collection process. Includes one of the following values: CycleProcessingStart, Pull_Processing, Pull_Done, Load_Processing, Load_Done, Completed, or Purge_Processing.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who started the data collection process.",
            "nullable":false,
            "x-queryable":true
        },
        "InstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the system where the collection process collected entities.",
            "nullable":false,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Time when the data collection process started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EntityList":{
            "maxLength":4000,
            "type":"string",
            "description":"List of codes for each entity that the user selected in the template for data collection. A comma ( , ) separates each value.",
            "nullable":true,
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the time that the collection process most recently collected data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitiesExpected":{
            "type":"number",
            "description":"Total count of entities that the collection process expects to process.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogNameList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of catalogs in Oracle Product Hub Cloud that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSFlatfileLoadJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent flat file load process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrgHierarchy":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of the sales organization hierarchy that the collection process collects.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source system where the collection process collected entities.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the collection process.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ConversionRateTypeList":{
            "maxLength":1000,
            "type":"string",
            "description":"List of currency conversion types that the collection process uses in the template. A comma ( , ) separates each value. If the list is empty, then the collection process collects all values.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to launch data collections process.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
servername/fscmRestApi/resources/version/dataCollections"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
            "TemplateName": "Static Data for Supply Planning",
            "SourceSystem": "GPR",
            "CollectionType": "1"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "InstanceId": null,
    "RefreshNumber": 0,
    "ProcPhase": null,
    "Status": null,
    "StartTime": null,
    "EndTime": null,
    "EntitiesExpected": null,
    "EntitiesProcessed": null,
    "CreatedBy": null,
    "CreationDate": null,
    "LastUpdatedBy": null,
    "LastUpdateDate": null,
    "OrgIdList": null,
    "EntityList": null,
    "ESSCollectionJobId": 120573,
    "PimOrgIdList": null,
    "CatalogNameList": null,
    "ConversionRateTypeList": null,
    "PriceList": null,
    "OrderTypeList": null,
    "CustomerClassCodeList": null,
    "CountryCodeList": null,
    "SalesOrgHierarchy": null,
    "TemplateName": "Static Data for Supply Planning",
    "Message": null,
    "SourceSystem": "GPR",
    "CollectionType": 2,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/dataCollections/0",
            "name": "dataCollections",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/dataCollections/0",
            "name": "dataCollections",
            "kind": "item"
        }
    ]
}

Back to Top