Insert/Update hierarchies item catalog

To insert one or more hierarchies item catalog, it's necessary to make a POST call, passing a JSON body as specified below.

Before calling this service you must have entered the catalogs using the service insertCatalogs_v3****.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

code : HTTP Code for the response

200 means the request was correctly processed

204 means a duplicate record was found in KeepIT, and that no insertion was performed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

errorObjects: Array that contains the objects that caused errors when processed

insertedObjects: Array that contains the correctly processed objects

progId: The identifier for the inserted/updated object

hierarchyCode: The identifier for hierarchy code

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
hierarchiesRecords	Array of hierarchies item catalog objects	An array of objects (see below for the complete structure).	✓

hierarchiesRecords example

"hierarchiesRecords":[
    {
        "levelNumber": "level hierarchie",
        "hierarchyCode": "code hierarchie",
        "description": "description hierarchie",
        "menu": "Indicates if is first menu level ('T' for first or 'F' for other)",
        "fatherLevelNumber": "superior level",
        "fatherHierarchyCode": "superior code hierarchie",
        "catalogCode": "catalog code",
        "tag": "tag",
        "position": "position",
        "status: "status"
    }
]

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful",
    "errorObjects": [],
    "insertedObjects": [
        {
            "progId": "2604",
            "hierarchyCode": "t"
        }
    ]
}

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
  "hierarchiesRecords": [
    {
      "levelNumber": "1",
      "hierarchyCode": "t",
      "description": "test livello1",
      "menu": "T",
      "catalogCode": "TEST_FEDE"
    },
    {
      "levelNumber": "2",
      "hierarchyCode": "t1",
      "description": "test livello2",
      "menu": "F",
      "fatherLevelNumber": "1",
      "fatherHierarchyCode": "t",
      "catalogCode": "TEST_FEDE"
    },
    {
      "levelNumber": "3",
      "hierarchyCode": "t2",
      "description": "test livello3",
      "menu": "F",
      "fatherLevelNumber": "2",
      "fatherHierarchyCode": "t1",
      "catalogCode": "TEST_FEDE"
    }
  ] 
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/Update hierarchies item catalog

Request

Request Code Samples

Responses