Supply Chain Insights

Live

Supply Chain Insights

+ Day(s) remaining in the trial

Overview

Leverage cognitive technology, trained in supply chain, to provide comprehensive search, visibility and insights across the entire supply chain. With Watson Supply Chain Insights, organizations can predict, assess and mitigate disruptions and risks and optimize the supply chain to deliver greater value to the business. For tutorials on how to use Watson Supply Chain Insights, visit the Watson Customer Engagement developerWorks page (https://developer.ibm.com/customer-engagement/supply-chain-insights/).

Getting started

Authentication

In order to call any IBM Watson Supply Chain Insights APIs, you need to obtain three HTTP headers: X-IBM-Client-Id, X-IBM-Client-Secret, and X-IBM-User-Secret. These credentials let you do anything and everything you would otherwise be able to do via the Watson Supply Chain Insights user interface. You can obtain the first two in APIexplorer if you have a subscription to IBM Watson Supply Chain Insights and have logged in to MyIBM. You have to log into IBM Watson Supply Chain Insights to obtain the X-IBM-User-Secret key.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Supply Chain Insights:

Bill of material

A list of the items and their quantities needed to manufacture an end product for sale to customers.
Add a new bill of material
Creates a new bill of material and returns the location of the created resource. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin

POST   /billofmaterial

			https://api.ibm.com/scinsights/run/api/billofmaterial
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Request code
Request model

_id

STRING , required

Adds a meaningful identification for a bill of material.

item

STRING , optional

Adds an item ID to a bill of material.

lastUpdatedByFeed

STRING , optional

Adds the ID of the data feed that last updated a specific bill of material.

meta

OBJECT , optional

meta

product

STRING , optional

Adds the IDs of products associated with a bill of material.

quantity

DOUBLE , optional

Adds item quantities to a bill of material.

recordCreated

DATETIME , optional

Adds the time at which a bill of material record was created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Adds the revision version number of a bill of material.

source

STRING , optional

Adds a bill of material record source (e.g. the name of a feed or remote system).

sourceLink

STRING , optional

Adds a link to a bill of material record source (e.g. the link to a feed or remote system).

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Adds the number of active issues associated with a bill of material.

activeIssues

ARRAY , optional

Adds the IDs of active issues associated with a bill of material.

activeKpis

ARRAY , optional

Adds the IDs of active KPIs associated with a bill of material.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Adds the number of inactive issues associated with a bill of material.

inactiveIssues

ARRAY , optional

Adds the IDs of inactive issues associated with a bill of material.

inactiveKpis

ARRAY , optional

Adds the IDs of inactive KPIs associated with a bill of material.

issues

OBJECT , optional

Adds the IDs of all issues associated with a bill of material.

Request example
{
  "_id": "HMCCR9_45W8687",
  "item": "45W8687",
  "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
  "product": "HMC CR9",
  "quantity": 49.0,
  "recordCreated": 2018-12-19T16:33:23.485+0000,
  "revisionNumber": "22",
  "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "sourceLink": "http://somedomain.com/"
}
Response model

201

Successfully created

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

405

Operation not allowed

Response example

201

Successfully created

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

405

Operation not allowed

Bulk process bill of material
Retrieve and modify bill of material records in bulk. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin

POST   /billofmaterial/bulk

			https://api.ibm.com/scinsights/run/api/billofmaterial/bulk
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Request code
Request model

allOrNothing

BOOLEAN , optional

This request is currently not supported.

deletes

ARRAY , optional

Deletes bill of material records as part of a bulk request.

inserts

ARRAY , optional

Inserts bill of material records as part of a bulk request.

updates

ARRAY , optional

Updates bill of material records as part of a bulk request.

upserts

ARRAY , optional

Updates and inserts bill of material records as part of a bulk request.

_id

STRING , required

Adds a meaningful identification for a bill of material.

item

STRING , optional

Adds an item ID to a bill of material.

lastUpdatedByFeed

STRING , optional

Adds the ID of the data feed that last updated a specific bill of material.

meta

OBJECT , optional

meta

product

STRING , optional

Adds the IDs of products associated with a bill of material.

quantity

DOUBLE , optional

Adds item quantities to a bill of material.

recordCreated

DATETIME , optional

Adds the time at which a bill of material record was created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Adds the revision version number of a bill of material.

source

STRING , optional

Adds a bill of material record source (e.g. the name of a feed or remote system).

sourceLink

STRING , optional

Adds a link to a bill of material record source (e.g. the link to a feed or remote system).

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Adds the number of active issues associated with a bill of material.

activeIssues

ARRAY , optional

Adds the IDs of active issues associated with a bill of material.

activeKpis

ARRAY , optional

Adds the IDs of active KPIs associated with a bill of material.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Adds the number of inactive issues associated with a bill of material.

inactiveIssues

ARRAY , optional

Adds the IDs of inactive issues associated with a bill of material.

inactiveKpis

ARRAY , optional

Adds the IDs of inactive KPIs associated with a bill of material.

issues

OBJECT , optional

Adds the IDs of all issues associated with a bill of material.

_id

STRING , required

Updates bill of material IDs as part of a bulk request.

item

STRING , optional

Updates item IDs in bills of material as part of a bulk request.

lastUpdatedByFeed

STRING , optional

Updates the IDs of the data feeds that last updated a specific bill of material.

meta

OBJECT , optional

meta

product

STRING , optional

Updates the IDs of products associated with specific bills of material as part of a bulk request.

quantity

DOUBLE , optional

Updates the quantities of materials associated with specific bills of material as part of a bulk request.

recordCreated

DATETIME , optional

Updates the times at which bill of material records were created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Updates the revision version numbers of bills of material as part of a bulk request.

source

STRING , optional

Updates bill of material record sources (e.g. the name of a feed or remote system) as part of a bulk request.

sourceLink

STRING , optional

Updates links to bill of material record sources (e.g. the name of a feed or remote system) as part of a bulk request.

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Updates the number of active issues associated with specific bills of material as part of a bulk request.

activeIssues

ARRAY , optional

Updates the IDs of active issues associated with specific bills of material as part of a bulk request.

activeKpis

ARRAY , optional

Updates the IDs of active KPIs associated with specific bills of material as part of a bulk request.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Updates the number of inactive issues associated with specific bills of material as part of a bulk request.

inactiveIssues

ARRAY , optional

Updates the IDs of inactive issues associated with specific bills of material as part of a bulk request.

inactiveKpis

ARRAY , optional

Updates the IDs of inactive KPIs associated with specific bills of material as part of a bulk request.

issues

OBJECT , optional

Updates the IDs of all issues associated with specific bills of material as part of a bulk request.

_id

STRING , optional

Updates and inserts bill of material IDs as part of a bulk request.

item

STRING , optional

Updates and inserts item IDs in bills of material as part of a bulk request.

lastUpdatedByFeed

STRING , optional

Updates and inserts IDs of the data feeds that last updated specific bills of material.

meta

OBJECT , optional

Updates and inserts bill of material records as part of a bulk request.

product

STRING , optional

Updates and inserts product IDs in bills of material as part of a bulk request.

quantity

DOUBLE , optional

Updates and inserts item quantities in bills of material as part of a bulk request.

recordCreated

DATETIME , optional

Updates and inserts the times at which bill of material records were created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Updates and inserts the revision version numbers of bills of material as part of a bulk request.

source

STRING , optional

Updates and inserts bill of material record sources (e.g. the name of a feed or remote system) as part of a bulk request.

sourceLink

STRING , optional

Updates and inserts links to bill of material record sources (e.g. the name of a feed or remote system) as part of a bulk request.

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Updates and inserts the sources of items on bills of material as part of a bulk request.

activeIssues

ARRAY , optional

Updates and inserts the IDs of active issues associated with specific bills of material as part of a bulk request.

activeKpis

ARRAY , optional

Updates and inserts the IDs of active KPIs associated with specific bills of material as part of a bulk request.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Updates and inserts the number of inactive issues associated with specific bills of material as part of a bulk request.

inactiveIssues

ARRAY , optional

Updates and inserts the IDs of inactive issues associated with specific bills of material as part of a bulk request.

inactiveKpis

ARRAY , optional

Updates and inserts the IDs of inactive KPIs associated with specific bills of material as part of a bulk request.

issues

OBJECT , optional

Updates and inserts the IDs of all issues associated with specific bills of material as part of a bulk request.

Request example
{
  "allOrNothing": false,
  "deletes": [],
  "inserts": [{
    "_id": "HMCCR9_45W8687",
    "item": "45W8687",
    "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
    "product": "HMC CR9",
    "quantity": 49.0,
    "recordCreated": 2018-12-19T16:33:23.485+0000,
    "revisionNumber": "22",
    "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "sourceLink": "http://somedomain.com/"
  }],
  "updates": [{
    "_id": "57ffcf6153ed0c73cc95eccc",
    "item": "45W8687",
    "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
    "product": "HMC CR9",
    "quantity": 49.0,
    "recordCreated": 2018-12-19T16:33:23.486+0000,
    "revisionNumber": "22",
    "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "sourceLink": "http://somedomain.com/"
  }],
  "upserts": [{
    "_id": "HMCCR9_45W8687",
    "item": "45W8687",
    "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
    "product": "HMC CR9",
    "quantity": 49.0,
    "recordCreated": 2018-12-19T16:33:23.486+0000,
    "revisionNumber": "22",
    "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "sourceLink": "http://somedomain.com/"
  }]
}
Response model

201

Successfully created

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

405

Operation not allowed

Response example

201

Successfully created

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

405

Operation not allowed

Delete bill of material by ID
Deletes an existing bill of material. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin

DELETE   /billofmaterial/{id}

			https://api.ibm.com/scinsights/run/api/billofmaterial/{id}
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Path and Query parameters

id

URL , required

The path name for a bill of material ID.

Request code
Response model

200

Operation successful

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Response example

200

Operation successful

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Find bill of material
Returns any existing bills of material that match your query.

GET   /billofmaterial

			https://api.ibm.com/scinsights/run/api/billofmaterial
		
Keys
Header parameters

Range

STRING , optional

The **Range** header may be used to specify a subset of the results to return. Format is `items=[firstResult]-[lastResult]`, zero-based, inclusive.

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Path and Query parameters

item

STRING , optional

Filters query results by item ID.

lastUpdatedByFeed

STRING , optional

Filters query results by the ID of the data feed that last updated a specific bill of material.

product

STRING , optional

Filters query results by product ID.

quantity

DOUBLE , optional

Filters query results by item quantity.

recordCreated

STRING , optional

Filters query results by the time at which a bill of material record was created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Filters query results by the revision version number of a bill of material.

source

STRING , optional

Filters query results by bill of material record source (e.g. the name of a feed or remote system).

sourceLink

STRING , optional

Filters query results by link to a bill of material record source (e.g. the link to a feed or remote system).

_id

STRING , optional

Filters query results by bill of material ID.

_range

STRING , optional

The **_range** query parameter may be used as an alternative to the equivalent HTTP header to specify a subset of the results to return. Format is `items=[firstResult]-[lastResult]`, zero-based, inclusive.

_sort

STRING , optional

The **_sort** query parameter may be used to specify how results should be sorted. Format is `[field1],[field2]`, etc. Prefix any field with a minus sign to indicate a descending sort.

_where

STRING , optional

The **_where** query parameter may be used to specify advanced search criteria.

Request code
Response model

200

Operation successful

Body

results

ARRAY , required

results

_id

STRING , required

_id

item

STRING , optional

The ID of some item.

lastUpdatedByFeed

STRING , optional

lastUpdatedByFeed

meta

OBJECT , optional

meta

product

STRING , optional

The ID of some product.

quantity

DOUBLE , optional

quantity

recordCreated

DATETIME , optional

recordCreated

revisionNumber

STRING , optional

revisionNumber

source

STRING , optional

source

sourceLink

STRING , optional

sourceLink

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

activeIssueCount

activeIssues

ARRAY , optional

activeIssues

activeKpis

ARRAY , optional

activeKpis

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

inactiveIssueCount

inactiveIssues

ARRAY , optional

inactiveIssues

inactiveKpis

ARRAY , optional

inactiveKpis

issues

OBJECT , optional

issues

206

Partial results

Body

results

ARRAY , required

results

_id

STRING , required

_id

item

STRING , optional

The ID of some item.

lastUpdatedByFeed

STRING , optional

lastUpdatedByFeed

meta

OBJECT , optional

meta

product

STRING , optional

The ID of some product.

quantity

DOUBLE , optional

quantity

recordCreated

DATETIME , optional

recordCreated

revisionNumber

STRING , optional

revisionNumber

source

STRING , optional

source

sourceLink

STRING , optional

sourceLink

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

activeIssueCount

activeIssues

ARRAY , optional

activeIssues

activeKpis

ARRAY , optional

activeKpis

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

inactiveIssueCount

inactiveIssues

ARRAY , optional

inactiveIssues

inactiveKpis

ARRAY , optional

inactiveKpis

issues

OBJECT , optional

issues

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Response example

200

Operation successful

								{
  "results" : [{
    "_id" : "HMCCR9_45W8687",
    "item" : "45W8687",
    "lastUpdatedByFeed" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "meta" : {
    "activeEventRules" : [string],
    "activeIssueCount" : 0,
    "activeIssues" : [string],
    "activeKpis" : [string],
    "inactiveEventRules" : [string],
    "inactiveIssueCount" : 0,
    "inactiveIssues" : [string],
    "inactiveKpis" : [string],
    "issues" : object
  },
    "product" : "HMC CR9",
    "quantity" : 49.0,
    "recordCreated" : 2018-12-19T16:33:23.482+0000,
    "revisionNumber" : "22",
    "source" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "sourceLink" : "http://somedomain.com/"
  }]
}
							

206

Partial results

								{
  "results" : [{
    "_id" : "HMCCR9_45W8687",
    "item" : "45W8687",
    "lastUpdatedByFeed" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "meta" : {
    "activeEventRules" : [string],
    "activeIssueCount" : 0,
    "activeIssues" : [string],
    "activeKpis" : [string],
    "inactiveEventRules" : [string],
    "inactiveIssueCount" : 0,
    "inactiveIssues" : [string],
    "inactiveKpis" : [string],
    "issues" : object
  },
    "product" : "HMC CR9",
    "quantity" : 49.0,
    "recordCreated" : 2018-12-19T16:33:23.482+0000,
    "revisionNumber" : "22",
    "source" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
    "sourceLink" : "http://somedomain.com/"
  }]
}
							

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Find bill of material by ID
Retrieves the details of a bill of material that matches the ID.

GET   /billofmaterial/{id}

			https://api.ibm.com/scinsights/run/api/billofmaterial/{id}
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Path and Query parameters

id

URL , required

The path name for a bill of material ID.

Request code
Response model

200

Operation successful

Body

_id

STRING , required

_id

item

STRING , optional

The ID of some item.

lastUpdatedByFeed

STRING , optional

lastUpdatedByFeed

meta

OBJECT , optional

meta

product

STRING , optional

The ID of some product.

quantity

DOUBLE , optional

quantity

recordCreated

DATETIME , optional

recordCreated

revisionNumber

STRING , optional

revisionNumber

source

STRING , optional

source

sourceLink

STRING , optional

sourceLink

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

activeIssueCount

activeIssues

ARRAY , optional

activeIssues

activeKpis

ARRAY , optional

activeKpis

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

inactiveIssueCount

inactiveIssues

ARRAY , optional

inactiveIssues

inactiveKpis

ARRAY , optional

inactiveKpis

issues

OBJECT , optional

issues

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Response example

200

Operation successful

								{
  "_id" : "HMCCR9_45W8687",
  "item" : "45W8687",
  "lastUpdatedByFeed" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "meta" : {
    "activeEventRules" : [string],
    "activeIssueCount" : 0,
    "activeIssues" : [string],
    "activeKpis" : [string],
    "inactiveEventRules" : [string],
    "inactiveIssueCount" : 0,
    "inactiveIssues" : [string],
    "inactiveKpis" : [string],
    "issues" : object
  },
  "product" : "HMC CR9",
  "quantity" : 49.0,
  "recordCreated" : 2018-12-19T16:33:23.483+0000,
  "revisionNumber" : "22",
  "source" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "sourceLink" : "http://somedomain.com/"
}
							

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Partially update bill of material by ID
Updates an existing bill of material and returns a 200 message if the call is successful. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin

PATCH   /billofmaterial/{id}

			https://api.ibm.com/scinsights/run/api/billofmaterial/{id}
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Path and Query parameters

id

URL , required

The path name for a bill of material ID.

Request code
Request model

item

STRING , optional

Updates the ID of an item that is associated with a bill of material.

lastUpdatedByFeed

STRING , optional

Updates the ID of the data feed that last updated a specific bill of material.

meta

OBJECT , optional

meta

product

STRING , optional

Updates the IDs of products associated with a bill of material.

quantity

DOUBLE , optional

Updates item quantities for a bill of material.

recordCreated

DATETIME , optional

Updates the time at which a bill of material record was created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Updates the revision version number of a bill of material.

source

STRING , optional

Updates a bill of material record source (e.g. the name of a feed or remote system).

sourceLink

STRING , optional

Updates a link to a bill of material record source (e.g. the link to a feed or remote system).

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Updates the number of active issues associated with a bill of material.

activeIssues

ARRAY , optional

Updates the IDs of active issues associated with a bill of material.

activeKpis

ARRAY , optional

Updates the IDs of active KPIs associated with a bill of material.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Updates the number of inactive issues associated with a bill of material.

inactiveIssues

ARRAY , optional

Updates the IDs of inactive issues associated with a bill of material.

inactiveKpis

ARRAY , optional

Updates the IDs of inactive KPIs associated with a bill of material.

issues

OBJECT , optional

Updates the IDs of all issues associated with a bill of material.

Request example
{
  "item": "45W8687",
  "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
  "product": "HMC CR9",
  "quantity": 49.0,
  "recordCreated": 2018-12-19T16:33:23.485+0000,
  "revisionNumber": "22",
  "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "sourceLink": "http://somedomain.com/"
}
Response model

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Response example

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Update bill of material by ID
Updates an existing bill of material and returns a 200 message if the call is successful. Caller must be a member of one or more of the following roles in order to invoke this method: dataAdmin

PUT   /billofmaterial/{id}

			https://api.ibm.com/scinsights/run/api/billofmaterial/{id}
		
Keys
Header parameters

X-IBM-User-Secret

STRING , required

X-IBM-Client-Secret

STRING , required

Identifies your Supply Chain Insights client secret.

X-IBM-Client-Id

STRING , required

Identifies your Supply Chain Insights subscription.

Path and Query parameters

id

URL , required

The path name for a bill of material ID.

Request code
Request model

item

STRING , optional

Updates the ID of an item that is associated with a bill of material.

lastUpdatedByFeed

STRING , optional

Updates the ID of the data feed that last updated a specific bill of material.

meta

OBJECT , optional

meta

product

STRING , optional

Updates the IDs of products associated with a bill of material.

quantity

DOUBLE , optional

Updates item quantities for a bill of material.

recordCreated

DATETIME , optional

Updates the time at which a bill of material record was created. Times must be in ISO 8601 format and they should indicate a time zone.

revisionNumber

STRING , optional

Updates the revision version number of a bill of material.

source

STRING , optional

Updates a bill of material record source (e.g. the name of a feed or remote system).

sourceLink

STRING , optional

Updates a link to a bill of material record source (e.g. the link to a feed or remote system).

activeEventRules

ARRAY , optional

activeEventRules

activeIssueCount

INTEGER , optional

Updates the number of active issues associated with a bill of material.

activeIssues

ARRAY , optional

Updates the IDs of active issues associated with a bill of material.

activeKpis

ARRAY , optional

Updates the IDs of active KPIs associated with a bill of material.

inactiveEventRules

ARRAY , optional

inactiveEventRules

inactiveIssueCount

INTEGER , optional

Updates the number of inactive issues associated with a bill of material.

inactiveIssues

ARRAY , optional

Updates the IDs of inactive issues associated with a bill of material.

inactiveKpis

ARRAY , optional

Updates the IDs of inactive KPIs associated with a bill of material.

issues

OBJECT , optional

Updates the IDs of all issues associated with a bill of material.

Request example
{
  "item": "45W8687",
  "lastUpdatedByFeed": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "meta": {
    "activeEventRules": [],
    "activeIssueCount": 0,
    "activeIssues": [],
    "activeKpis": [],
    "inactiveEventRules": [],
    "inactiveIssueCount": 0,
    "inactiveIssues": [],
    "inactiveKpis": [],
    "issues": object
  },
  "product": "HMC CR9",
  "quantity": 49.0,
  "recordCreated": 2018-12-19T16:33:23.483+0000,
  "revisionNumber": "22",
  "source": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit laborum.",
  "sourceLink": "http://somedomain.com/"
}
Response model

200

Operation successful

400

Validation exception

Body

error

STRING , optional

error

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Response example

200

Operation successful

400

Validation exception

								{
  "error" : "Something went wrong."
}
							

401

Client could not be authenticated

403

Client is not authorized

404

Resource not found

405

Operation not allowed

Loading content...