API: Log types and configurations
GET /api/rest/v1/log-types-with-configs
Retrieve all log types along with their associated system attribute configurations and section metadata.
Security
Bearer Token Authentication (BearerAuth).
Headers
| Key | Value | Description | Required |
|---|---|---|---|
|
Authorization |
Bearer <token> |
The bearer token for authentication and access. |
Yes |
Request
Query Parameter: None
Request Body: None
Response
Status Code: 200 OK
Content-Type: application/json
Response example
{
"rest_log_types_with_configs": [
{
"id": 27,
"log_types": {
"id": 27,
"type_name": "Issue 2",
"description": "",
"is_published": false,
"allow_email_notification": true,
"is_deleted": false,
"created_at": "2024-01-12T14:04:14.180634",
"log_type_categories_id": 5,
"log_types_section": [
{
"id": 12,
"is_default_section": true,
"section_custom_attribute": [
{
"id": 1960,
"ca_order": 1000,
"section_id": 12,
"is_mandatory": false,
"display_name": null,
"is_deleted": false,
"custom_attribute_config": {
"config_type": "url",
"name": "URL CA",
"id": 560,
"created_at": "2025-01-09T13:05:58.392424",
"is_archived": false,
"is_deleted": false
}
}
]
}
]
},
"system_attribute_log_types": [
{
"id": "113",
"is_mandatory": false,
"name": "Description",
"sa_ids": [
1
]
}
]
}
]
}
Schema Definitions
LogTypesWithConfigsResponse
|
Field |
Type |
Description |
Example |
|---|---|---|---|
|
|
|
Unique identifier for the log type. |
|
|
|
|
List of log types with their section configurations. |
|
|
|
|
Represents a system-defined attribute that can be configured per log type. These attributes include status, description, assignee, due date, etc |
log_types
|
Field |
Type |
Description |
Example |
|---|---|---|---|
|
|
|
Log type ID |
|
|
|
|
Name of the log type |
|
|
|
|
Description |
|
|
|
|
Whether the type is published |
|
|
|
|
Whether the type is deleted |
|
|
|
|
Creation timestamp |
|
|
|
|
Category ID |
|
|
|
|
Sections within this log type |
log_types_section
|
Field |
Type |
Description |
Example |
|---|---|---|---|
|
|
|
Section ID |
|
|
|
|
Whether this section is default |
|
|
|
|
This object defines a custom attribute assigned to a section, including its configuration details and selectable options (for attributes like dropdowns). |
section_custom_attribute
|
Field |
Type |
Description |
|---|---|---|
|
|
|
Unique identifier for the section-custom attribute mapping |
|
|
|
Determines display order of the custom attribute within the section |
|
|
|
Identifier of the section this attribute belongs to |
|
|
|
Whether the attribute must be filled in by the user |
|
|
|
Optional override for the default name shown to users |
|
|
|
Indicates if the mapping is soft-deleted |
|
|
|
Configuration details for this custom attribute |
section_custom_attribute example
{
"id": 1931,
"ca_order": 7000,
"section_id": 499,
"is_mandatory": false,
"display_name": null,
"is_deleted": false,
"custom_attribute_config": {
"config_type": "singleselect",
"name": "Single CA",
"id": 564,
"created_at": "2025-01-09T13:07:14.421668",
"is_archived": false,
"is_deleted": false,
"config_value": {
"options": [
{
"id": "e96ccee19dba439d875c9a177451428b",
"label": "X",
"value": "X"
},
{
"id": "e93dec835375411a9416138e53951cc7",
"label": "Y",
"value": "Y"
},
{
"label": "Z",
"value": "Z",
"id": "321ba574dd4042659d125eb326c8f13e"
}
]
},
"tooltip": ">",
},
}
custom_attribute_config
|
Field |
Type |
Description |
|---|---|---|
|
|
|
Unique identifier of the attribute config |
|
|
|
Name of the custom attribute |
|
|
|
Type of the attribute ( |
|
|
|
Timestamp when the attribute was created |
|
|
|
Whether this config is archived |
|
|
|
Whether this config is marked as deleted |
|
|
|
Contains |
|
|
|
UI tooltip or helper text shown to the user |
config_value.options[] (Applicable for Select Types)
|
Field |
Type |
Description |
Example |
|---|---|---|---|
|
|
|
Unique ID of the selectable option |
"e96ccee..." |
|
|
|
Label shown in the UI dropdown |
"X" |
|
|
|
Value stored when selected |
"X" |
system_attribute_log_types
|
Field |
Type |
Description |
|---|---|---|
|
|
|
Unique identifier for the system attribute (may be concatenated if grouped) |
|
|
|
Display name of the system attribute (e.g., "Status", "Assignee") |
|
|
|
If true, this attribute must be filled during log creation |
|
|
|
System attribute ID(s) associated with this config |
|
|
|
Type of the attribute ( |
|
|
|
Configuration options, if applicable (for select types) |
config_value.options[] (Only for singleselect/multiselect)
|
Field |
Type |
Description |
Example |
|---|---|---|---|
|
|
|
Unique ID of the option |
|
|
|
|
Display label for the dropdown item |
"Open" |
|
|
|
Value stored when this is selected |
|
|
|
|
Whether this option is shown in UI |
true |
system_attribute_log_types example
"system_attribute_log_types": [
{
"id": "3095",
"is_mandatory": false,
"name": "Description",
"sa_ids": [
1
],
"config_type": "longtext",
"config_value": null,
},
{
"id": "3096",
"is_mandatory": true,
"name": "Status",
"sa_ids": [
2
],
"config_type": "singleselect",
"config_value": {
"options": [
{
"id": 1,
"is_visible": true,
"label": "New",
"value": "New"
},
{
"id": 2,
"is_visible": true,
"label": "Open",
"value": "Open"
},
{
"id": 3,
"is_visible": true,
"label": "In progress",
"value": "In progress"
},
{
"id": 4,
"is_visible": true,
"label": "On hold",
"value": "On hold"
},
{
"id": 6,
"is_visible": false,
"label": "Transferred",
"value": "Transferred"
},
{
"id": 7,
"is_visible": true,
"label": "Cancelled",
"value": "Cancelled"
},
{
"id": 5,
"is_visible": true,
"label": "Closed",
"value": "Closed"
}
]
},
},
{
"id": "3097",
"is_mandatory": false,
"name": "Assignee",
"sa_ids": [
3
],
"config_type": "singleselect",
"config_value": null,
},
{
"id": "3098",
"is_mandatory": false,
"name": "Association",
"sa_ids": [
4
],
"config_type": "multiselect",
"config_value": null,
},
{
"id": "3099",
"is_mandatory": false,
"name": "Due date",
"sa_ids": [
5
],
"config_type": "date",
"config_value": null,
},
{
"id": "3100",
"is_mandatory": false,
"name": "Probability",
"sa_ids": [
6
],
"config_type": "singleselect",
"config_value": {
"options": [
{
"id": "8edd7a07ef584c6f8572c3d99a39a277",
"label": "Very unlikely",
"value": 1
},
{
"id": "890fe22d7ba64b21851fb4dfd09ddaa6",
"label": "Not likely",
"value": 2
},
{
"id": "4239c13f97fc4d57a7fc2afd187ba3ba",
"label": "Possible",
"value": 3
},
{
"id": "0391005b7b724a999427ecb8082e3aa4",
"label": "Probable",
"value": 4
},
{
"id": "05af524c306c4843ad3a2791b8091226",
"label": "Very likely",
"value": 5
}
]
},
},
{
"id": "3101",
"is_mandatory": false,
"name": "Impact",
"sa_ids": [
7
],
"config_type": "singleselect",
"config_value": {
"options": [
{
"id": "d13ab38d898e429589820c45bdbf5177",
"label": "Low",
"value": 1
},
{
"id": "c333ec7bf1d4415db1e78c47ab9d09b4",
"label": "Minor",
"value": 2
},
{
"id": "19fb56b726324af3a622a2e9979ea0d6",
"label": "Moderate",
"value": 3
},
{
"id": "6a4e465183594b8abc63f289fe0dea62",
"label": "Significant",
"value": 4
},
{
"id": "4683775fced94c129885e3e34993db75",
"label": "Critical",
"value": 5
}
]
}
},
{
"id": "3100,3101",
"is_mandatory": false,
"name": "Risk analysis",
"sa_ids": [
6,
7
],
"config_type": "singleselect",
"config_value": null,
}
]