Create Systemic Tag Value

Endpoint utilizado para crear el valor de un tag sistémico en el servicio Index utilizando la información entregada en la request. Para que la petición sea considerada válida, es obligatorio entregar el valor de la variable de ruta company_id y de los campos name y systemic_tag_name. Si se provee un par [company_id|name] que ya se encuentra presente en otro tag, se considera un duplicado y el recurso no es creado.

Endpoint

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{access_token}}	access_token obtained in Atenea

Method: POST

URL: https://api.trust.lat/index/v1/company/:company_id/systemic_tag_value

Path Variables:

Key	Value Example	Description
company_id	99	Identificador de compañia provisto por empresa Trust. Obligatorio.

caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea

Como obtener un access token

Body

Fields

• name: Nombre del valor del tag sistémico. Obligatorio.
• systemic_tag_name: Texto que contiene el tipo de tag sistémico. Sólo puede tomar los valores [systemic_sub_company|systemic_client_type]. Obligatorio.
• description: Breve explicación sobre el valor del tag sistémico. Opcional.
• color: Código hexadecimal asociado a un color RGB, utilizado para representar al tag. Opcional.

Example

{

"name": "Lucchezzi",

"systemic_tag_name": "systemic_sub_company",

"description": "Empresa de fideos",

"color": "#FF0000"

}

Code Examples

Curl

curl --location --request POST 'https://api.trust.lat/index/v1/company/99/systemic_tag_value' \

--header 'Authorization: Bearer ************' \

--header 'Content-Type: application/json' \

--data-raw '{

"name": "Lucchezzi",

"systemic_tag_name": "systemic_sub_company",

"description": "Empresa de fideos",

"color": "#FF0000"

}'

JavaScript

import requests

url = "https://api.trust.lat/index/v1/company/99/systemic_tag_value"

payload="{\n \"name\": \"Lucchezzi\",\n \"systemic_tag_name\": \"systemic_sub_company\",\n \"description\": \"Empresa de fideos\",\n \"color\": \"#FF0000\"\n}"

headers = {

'Authorization': 'Bearer ************',

'Content-Type': 'application/json'

}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Python

var axios = require('axios');

var data = JSON.stringify({"name":"Lucchezzi","systemic_tag_name":"systemic_sub_company","description":"Empresa de fideos","color":"#FF0000"});

var config = {

method: 'post',

url: 'https://api.trust.lat/index/v1/company/99/systemic_tag_value',

headers: {

'Authorization': 'Bearer ************',

'Content-Type': 'application/json'

},

data : data

};

axios(config)

.then(function (response) {

console.log(JSON.stringify(response.data));

})

.catch(function (error) {

console.log(error);

});

Responses

HTTP Code: 201 Created

Systemic Tag Value successfully created in Index

{

"code": 201,

"resource": "SystemicTagsValue",

"data": {

"color": "#FF0000",

"company_id": "99",

"created_at": "2021-07-08T21:38:42.800Z",

"description": "Empresa de fideos",

"name": "Lucchezzi",

"systemic_tag_name": "systemic_sub_company",

"updated_at": "2021-07-08T21:38:42.800Z",

"uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff"

},

"message": "Created"

}

HTTP Code: 409 Conflict

Systemic tag value already present in service

{

"code": 409,

"resource": "SystemicTagsValue",

"message": "Duplicated",

"errors": {

"color": "#FF0000",

"company_id": "99",

"created_at": "2021-07-08T21:38:42.800Z",

"description": "Empresa de fideos",

"name": "Lucchezzi",

"systemic_tag_name": "systemic_sub_company",

"updated_at": "2021-07-08T21:38:42.800Z",

"uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff"

}

}

HTTP Code: 422 Unprocessable Entity

Missing or wrong fields values

{

"code": 422,

"resource": "SystemicTagsValue",

"message": "Fail",

"errors": {

"name": [

"can't be blank"

],

"systemic_tag_name": [

"is not included in the list"

]

}

}