Authentication
Endpoints
Development
Update Entity
Update an existing entity.
curl --request PUT \
--url https://public.api.serval.com/v2/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"fieldValues": [
{
"boolValue": true,
"entityRefValue": "<string>",
"enumValue": "<string>",
"numberValue": 123,
"textValue": "<string>",
"timestampValue": "2023-11-07T05:31:56Z",
"userRefValue": "<string>"
}
]
}
'{
"data": {
"id": "<string>",
"teamId": "<string>",
"entityTypeId": "<string>",
"key": "<string>",
"name": "<string>",
"number": 123,
"createdByUserId": "<string>",
"updatedByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"document": "<string>",
"entityTypeKey": "<string>",
"entitySchemaKey": "<string>",
"entitySchemaId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the entity.
Body
The name of the entity.
The field values to update.
Show child attributes
Show child attributes
Option: bool_value
Option: entity_ref_value
Option: enum_value
Option: number_value
Option: text_value
Option: timestamp_value
Option: user_ref_value
Response
Success
The updated entity.
Show child attributes
Show child attributes
The ID of the entity.
The ID of the team that the entity belongs to.
The ID of the entity type.
The unique key for the entity within its type.
The name of the entity.
The sequential number for the entity within the team.
The ID of the user who created the entity.
The ID of the user who last updated the entity.
The timestamp when the entity was created.
The timestamp when the entity was last updated.
The entity's document data as a JSON string.
The key of the entity type.
The key of the entity schema.
The ID of the entity schema.
Was this page helpful?
curl --request PUT \
--url https://public.api.serval.com/v2/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"fieldValues": [
{
"boolValue": true,
"entityRefValue": "<string>",
"enumValue": "<string>",
"numberValue": 123,
"textValue": "<string>",
"timestampValue": "2023-11-07T05:31:56Z",
"userRefValue": "<string>"
}
]
}
'{
"data": {
"id": "<string>",
"teamId": "<string>",
"entityTypeId": "<string>",
"key": "<string>",
"name": "<string>",
"number": 123,
"createdByUserId": "<string>",
"updatedByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"document": "<string>",
"entityTypeKey": "<string>",
"entitySchemaKey": "<string>",
"entitySchemaId": "<string>"
}
}