⚠️Trigger New Job on Alert

Create new job in illu when an issue occurs

Create Job

Create a new job. Uses default job status, tag, and site if those arguments are not provided.

POST/orgs/{org_id}/jobs

Path parameters

org_id*Org Id

Body

name*Name

status_idStatus Id

0: to do1: in progress2: done3: closed

type_tag_idType Tag Id

site_idSite Id

due_dateDue Date

assigned_user_idAssigned User Id

stageStage

0: other1: sales/design2: installation3: commissioning4: maintenance5: decommissioning

notesNotes

repeat_interval_typeRepeat Interval Type

repeat_interval_numRepeat Interval Num

tag_idsTag Ids

collaborator_idsCollaborator Ids

workflow_instancesWorkflow Instances

template_idTemplate Id

custom_fieldsCustom Fields

Response

Successful Response

Body

id*Id

name*Name

status*JobStatus

id: The id of the job status. name: The name of the job status.

type_tag*JobTag

id: The id of the job tag. name: The name of the job tag.

org_id*Org Id

site_id*Site Id

site_name*Site Name

siteSite

site_id: The id of the site. name: The name of the site. is_active: Whether the site has been deleted. org_id: The id of the site's organization latitude: The latitude gps coordinate of the site. longitude: The longitude gps coordinate of the site. address: The address of site share_data: Whether to share location data with linked provider orgs components: A list of components associated with the site

due_date*Due Date

assigned_user*UserLite

Model for basic user info for jobs etc.

id: the unique identifier for the user

name: The name of the user

stageJobStage

0: OTHER1: SALES_DESIGN2: INSTALLATION3: COMMISSIONING4: MAINTENANCE5: DECOMMISSIONING

012345

notesNotes

repeat_interval_typeRepeat Interval Type

repeat_interval_numRepeat Interval Num

tagsTags

collaboratorsCollaborators

last_modified*Last Modified

workflow_instancesWorkflow Instances

job_imagesJob Images

template_idTemplate Id

custom_fieldsCustom Fields

Request

const response = await fetch('/orgs/{org_id}/jobs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": {
    "name": "text"
  },
  "type_tag": {
    "name": "text"
  },
  "site_name": "text",
  "site": {
    "name": "text",
    "is_active": false,
    "latitude": 0,
    "longitude": 0,
    "address": "text",
    "share_data": false,
    "components": [
      {
        "equipment_data": {
          "manufacturer": "text",
          "model_name": "text",
          "type_id": {},
          "description": "text",
          "active": false
        },
        "name": "text",
        "serial_num": "text",
        "notes": "text",
        "added_on": "2024-11-21T06:24:34.159Z"
      }
    ]
  },
  "due_date": "text",
  "assigned_user": {
    "name": "text"
  },
  "stage": 0,
  "notes": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "collaborators": [
    {
      "name": "text"
    }
  ],
  "last_modified": "text",
  "workflow_instances": [
    {
      "workflow_def_name": "text",
      "workflow_def_org_name": "text",
      "workflow_def_description": "text",
      "workflow_instance_name": "text",
      "workflow_instance_notes": "text",
      "workflow_status": 1,
      "step_instance_data": [
        {
          "step_def_data": {
            "image_path": "text",
            "text_data": "text",
            "name": "text",
            "step_type": 0
          },
          "step_status": 1,
          "text_input": "text",
          "number_input": 0,
          "images": [
            {
              "submitter": {
                "name": "text"
              },
              "post_date": "text",
              "notes": "text",
              "image_path": "text",
              "media": {
                "uuid": "text",
                "name": "text",
                "content_type": "text",
                "category": 0,
                "url": "text"
              }
            }
          ],
          "notes": "text"
        }
      ],
      "last_modified": "2024-11-21T06:24:34.159Z"
    }
  ],
  "job_images": [
    {
      "submitter": {
        "name": "text"
      },
      "post_date": "text",
      "notes": "text",
      "image_path": "text",
      "media": {
        "uuid": "text",
        "name": "text",
        "content_type": "text",
        "category": 0,
        "url": "text"
      }
    }
  ]
}

Example code:

curl -X 'POST' https://api.illu.works/orgs/{org_id}/jobs \
  -H 'Authorization: Bearer API_KEY' \
  --json '{"name": "Alarm triggered job", "notes": "Some issue with the system"}, "site_id"={site_id}}'

PreviousAPI Examples NextCreate New Site on Project Start

Last updated 1 year ago

const response = await fetch('/orgs/{org_id}/jobs', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text" }), }); const data = await response.json();

{ "name": "text", "status": { "name": "text" }, "type_tag": { "name": "text" }, "site_name": "text", "site": { "name": "text", "is_active": false, "latitude": 0, "longitude": 0, "address": "text", "share_data": false, "components": [ { "equipment_data": { "manufacturer": "text", "model_name": "text", "type_id": {}, "description": "text", "active": false }, "name": "text", "serial_num": "text", "notes": "text", "added_on": "2024-11-21T06:24:34.159Z" } ] }, "due_date": "text", "assigned_user": { "name": "text" }, "stage": 0, "notes": "text", "tags": [ { "name": "text" } ], "collaborators": [ { "name": "text" } ], "last_modified": "text", "workflow_instances": [ { "workflow_def_name": "text", "workflow_def_org_name": "text", "workflow_def_description": "text", "workflow_instance_name": "text", "workflow_instance_notes": "text", "workflow_status": 1, "step_instance_data": [ { "step_def_data": { "image_path": "text", "text_data": "text", "name": "text", "step_type": 0 }, "step_status": 1, "text_input": "text", "number_input": 0, "images": [ { "submitter": { "name": "text" }, "post_date": "text", "notes": "text", "image_path": "text", "media": { "uuid": "text", "name": "text", "content_type": "text", "category": 0, "url": "text" } } ], "notes": "text" } ], "last_modified": "2024-11-21T06:24:34.159Z" } ], "job_images": [ { "submitter": { "name": "text" }, "post_date": "text", "notes": "text", "image_path": "text", "media": { "uuid": "text", "name": "text", "content_type": "text", "category": 0, "url": "text" } } ] }