Insert/Update entity clusters

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

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

clusterCode: The identifier for cluster code

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

Field	Description	Type	Mandatory
clustersRecords	Array of entity cluster objects	An array of objects (see below for the complete structure).	✓

Entity clusters section

Field	Description	Type	Mandatory
entityClusterType	Entity cluster type	Varchar(250)	✓
clusterCode	Cluster code	Varchar(250)	✓
description	Cluster description.You can also pass the description in language (e.g. descriptionIt)	Varchar(250)	✓
flagshipEntity	It indicates if the entity type is referred to is a flagship entity ('T' for referred or 'F' for not referred)	Char(1)	✓
status	Indicates wether the cluster is active or not ('E' for actived or 'D' for not actived)	Char(1)

Cluster entities section

Field	Description	Type	Mandatory
entityCode	Entity code	Varchar(250)	✓
status	Indicates wether the entity is active or not for cluster ('D' for actived or 'E' for not actived)	Varchar(250)	✓

clustersRecords example

"clustersRecords": [{
    "entityClusters": {
        "entityClusterType": "entity cluster type",
        "clusterCode": "cluster code",
        "description": "cluster description",
        "flagshipEntity": "It indicates if the entity type is referred to is a flagship entity ('T' for referred or 'F' for not referred)"
    },
    "clusterEntities": [{
        "entityCode": "entity code",
        "status": "Indicates wether the entity is active or not for cluster ('D' for actived or 'E' for not actived)"
    }]
}]

Response example

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

Notes

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

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ "clustersRecords": [ { "entityClusters": { "entityClusterType": "VISIBILITY", "clusterCode": "51", "description": "Transiti concessi filiale 51", "flagshipEntity": "F" }, "clusterEntities": [ { "entityCode": "10", "status": "E" }, { "entityCode": "1", "status": "E" } ] } ] }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/Update entity clusters

Request

Request Code Samples

Responses