JSON Item Creation API

Add new Items to KaiNexus with the JSON Item Creation API.

NOTE: In order to create new Items via API, your organization must have the API Module enabled. Reach out to your Customer Experience Lead to take advantage of this feature.

The JSON Item Creation can be used to create new Items in KaiNexus.

To update a list of Items with JSON use the URL:

https://api.kainexus.com/api/public/v1/json/item

To update an individual Item use the URL:

https://api.kainexus.com/api/public/v1/json/itemList

Example Curl Script:

curl -s -D - --user api:APIKEY https://api.kainexus.com/api/public/v1/json/item -d @FILEPATH -X PUT -H "Content-Type: application/json"

See The API Module for more information on how to configure API keys.

CAUTION: The file must be UTF-8 encoded.

Things to note:

By default, anyone who would be notified a new Item created within KaiNexus will also be notified about new Items made with the Item Creation API.

To suppress these notifications for an Item included in your import, add the following line to that Item's code segment. This line must be added for each Item for which notification should be suppressed.

"suppressNotifications": true

The item(s) being updated must be referenced by ID. Fields, Attributes, and Attribute Values can be referenced by name or ID.
Person Attributes can be referenced by username or ID.
Location Attributes can be referenced by name or ID.
To update an Attribute that belongs on a Weighted Score, the name or ID of the Weighted Score must be provided.
A note can be included on Attribute Values that support notes.
Fields require a key to their value dependent on the Field's type.
- 'dateValue' for date fields.
- 'numericValue' for number fields.
- 'value' for text fields.

Milestone Approver system Roles will be taken into account when using an API Key. Meaning, if your API Key does not have the same Role(s) as the one(s) listed as the only acceptable Approver(s) then this could result in a permissions error.
Fields require a key to their value dependent on the Field's type.
- 'dateValue' for date fields.
- 'numericValue' for number fields.
- 'value' for text fields.
Milestone Approver system Roles will be taken into account when using an API Key. Meaning, if your API Key does not have the same Role(s) as the one(s) listed as the only acceptable Approver(s) then this could result in a permissions error.

Example new Item submission:

{
  "item": {
    "templateName": "A3",
    "summary": "API created A3",
    "status": "NEW",
    "createDate": "2020-07-08T05:00:00.000+0000",
    "lastUpdateDate": "2020-07-08T05:00:00.000+0000",
    "authors": [
      {
        "username": "greg"
      },
      {
        "username": "abby"
      }
    ]
  }
}