Appearance
AssignmentCustomAttributeDefinition
The fields a company adds to its assignments in its settings, such as a floor area or an order number of its own. An Assignment holds their values in customAttributes, by the definition's uuid. Definitions are set up in Artesa, so this API only reads them.
OpenAPI Spec
List AssignmentCustomAttributeDefinitions
GET
/v2/assignment-custom-attribute-definitions
List AssignmentCustomAttributeDefinitions
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Query Parameters
page
Type
number
Minimum
0Default
0size
Type
number
Minimum
1Maximum
20Default
10uuid
name
type
Definitions of this type, or one of these.
deactivatedAt
createdAt
updatedAt
Responses
List response
application/json
JSON "page": 0, "pages": 0, "size": 10, "items": [ { "uuid": "string", "name": "string", "description": "string", "type": "string", "required": true, "order": 0, "settings": { "prepend": "string", "append": "string", "min": 0, "max": 0, "step": 0, "precision": 0, "default": true, "jsonSchema": { "additionalProperties": "string" } }, "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string" } ]
{
}
Get an AssignmentCustomAttributeDefinition
GET
/v2/assignment-custom-attribute-definitions/{assignmentCustomAttributeDefinitionUuid}
Get an AssignmentCustomAttributeDefinition by ID
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Path Parameters
assignmentCustomAttributeDefinitionUuid*
Type
Requiredstring
Format
"uuid"Responses
AssignmentCustomAttributeDefinition found
application/json
JSON "uuid": "string", "name": "string", "description": "string", "type": "string", "required": true, "order": 0, "settings": { "prepend": "string", "append": "string", "min": 0, "max": 0, "step": 0, "precision": 0, "default": true, "jsonSchema": { "additionalProperties": "string" } }, "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string"
{
}