System
All the objects in SIM can be related to the system breakdown structure. SIM supports multi-level system breakdown structures stored as a tree. The system breakdown structure is not the same as the work breakdown structure.
System Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the systems's id |
| name | string | the system's name (2-60 characters) |
| description | string | the system's description |
| root_id | snowflake? | the root system's ID |
| parent_id | snowflake? | the parent system's ID |
Get System
GET /systems/{system.id}
List Systems
GET /organisations/{organisation.id}/systems
Parameters
| Field | Type | Description |
|---|---|---|
| root | ?boolean | when set to true, only the root systems will be returned |
Create System
POST /organisations/{organisation.id}/systems
Update System
PATCH /systems/{system.id}
Delete System
Cannot delete systems, use Update setting NotUsed to True