Absorb Integration API (v1)

Download OpenAPI specification:Download

Custom Field Definitions

List custom fields and their definitions.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The custom field definition ID.
name	string The custom field definition descriptive name.
customField	string The name of the custom field.
type	integer Enum: 0 1 2 3 4 5 The field type. Possible Enum Values: `0 = Boolean` `1 = Date` `2 = DateTime` `3 = Decimal` `4 = Integer` `5 = Text`
behavior	integer Enum: 0 1 2 3 4 The behaviour of the field. Possible Enum Values: `0 = Optional` `1 = Required` `2 = Hidden` `3 = Locked` `4 = ReadOnly`
	Array of objects (CustomFieldDefinitionPossibleValueResource) List of possible values for this field.
isPrivate	boolean True if this field is private, false otherwise.

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"customField": "string",
"type": 0,
"behavior": 0,
"possibleValues": [{"id": "string",
"customFieldDefinitionId": "string",
"name": "string"
}
],
"isPrivate": true
}
]

Create a custom field definition and its possible values (if any).

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request to create a custom field definition and its possible values (if any).

name required	string [ 0 .. 255 ] characters The name of the custom field definition.
customField required	string [ 0 .. 255 ] characters The custom field it is related to (e.g. "String2", "Bool1").
type required	integer Enum: 0 1 2 3 4 5 The field definition type. Possible Enum Values: `0 = Boolean` `1 = Date` `2 = DateTime` `3 = Decimal` `4 = Integer` `5 = Text`
behavior required	integer Enum: 0 1 2 3 4 The behavior of the custom field definition. Possible Enum Values: `0 = Optional` `1 = Required` `2 = Hidden` `3 = Locked` `4 = ReadOnly`
isPrivate required	boolean True if the field is private, False otherwise.
regex	string [ 0 .. 255 ] characters The regex for the custom field definition, if any.
order	integer <int32> The order of the custom field definition.
possibleValues	Array of strings A list of possible custom field definition values.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"customField": "string",
"type": 0,
"behavior": 0,
"isPrivate": true,
"regex": "string",
"order": 0,
"possibleValues": ["string"
]
}

Response samples

400
409

Content type

application/json

{"validations": ["string"
],
"code": 0,
"message": "string",
"term": "string",
"_meta": {"property1": "string",
"property2": "string"
}
}

Get a specific custom field and it's definition.

Authorizations:

api_key

path Parameters

customFieldDefinitionId

required

string <guid>

The custom field definition ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The custom field definition ID.
name	string The custom field definition descriptive name.
customField	string The name of the custom field.
type	integer Enum: 0 1 2 3 4 5 The field type. Possible Enum Values: `0 = Boolean` `1 = Date` `2 = DateTime` `3 = Decimal` `4 = Integer` `5 = Text`
behavior	integer Enum: 0 1 2 3 4 The behaviour of the field. Possible Enum Values: `0 = Optional` `1 = Required` `2 = Hidden` `3 = Locked` `4 = ReadOnly`
	Array of objects (CustomFieldDefinitionPossibleValueResource) List of possible values for this field.
isPrivate	boolean True if this field is private, false otherwise.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"customField": "string",
"type": 0,
"behavior": 0,
"possibleValues": [{"id": "string",
"customFieldDefinitionId": "string",
"name": "string"
}
],
"isPrivate": true
}

Update a custom field definition and its possible values (if any).

Authorizations:

api_key

path Parameters

customFieldDefinitionId

required

string <guid>

The custom field definition ID.

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request body to update a custom field definition and its possible values (if any).

name	string [ 0 .. 255 ] characters The name of the custom field definition.
customField	string [ 0 .. 255 ] characters The custom field it is related to (e.g. "String2", "Bool1").
behavior	integer Enum: 0 1 2 3 4 The behavior of the custom field definition. Possible Enum Values: `0 = Optional` `1 = Required` `2 = Hidden` `3 = Locked` `4 = ReadOnly`
isPrivate	boolean True if the field is private, False otherwise.
regex	string [ 0 .. 255 ] characters The regex for the custom field definition, if any.
order	integer <int32> The order of the custom field definition.
	Array of objects (CustomFieldDefinitionPossibleValuesDefinition) A list of possible custom field definition values.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"customField": "string",
"behavior": 0,
"isPrivate": true,
"regex": "string",
"order": 0,
"possibleValues": [{"id": "string",
"customFieldDefinitionId": "string",
"name": "string"
}
]
}

Response samples

400
404
409

Content type

application/json

{"validations": ["string"
],
"code": 0,
"message": "string",
"term": "string",
"_meta": {"property1": "string",
"property2": "string"
}
}