Powered by Temper

JSON Item Creation API

KaiNexus 2.4.7 adds support for creating new Items using JSON.

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

 

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

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

 

To update an individual Item use the URL:

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

 

Example Curl Script:

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

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

 

Things to note:

  1. The item(s) being updated must be referenced by ID. Fields, Attributes, and Attribute Values can be referenced by name or ID.

  2. Person Attributes can be referenced by username or ID.

  3. Location Attributes can be referenced by name or ID.

  4. To update an Attribute that belongs on a Weighted Score, the name or ID of the Weighted Score must be provided. 

  5. A note can be included on Attribute Values that support notes.

  6. Fields require a key to their value dependent on the Field's type. 

    1. 'dateValue' for date fields.
    2. 'numericValue' for number fields.
    3. 'value' for text fields.

 

 

Example new Item submission:

{
  "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"
    }
  ]
}

 

Have more questions? Submit a request