Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

jobs_id

Foreign key of the jobs

globally unique identifier

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs_reference_back_office

Embedded entity "jobs" using ERP PK when adding/updating

string

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs

Embedded entity "jobs" when adding/updating

jobs

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

work_instruction_details_id

work instruction details id

globally unique identifier
work_instruction_details_reference_back_office

Embedded code "work instruction details" when adding/updating

string
work_instruction_details

Embedded entity "work instruction details" when adding/updating

work_instruction_details
user_id

Filled by the person that completed that item on the checklist

globally unique identifier
work_instruction_action_type

Value from work_instruction_action_type.name

string
work_instruction_id

work instruction id

globally unique identifier

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction_reference_back_office

Embedded code "work instruction" when adding/updating

string

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction

Embedded entity "work instruction" when adding/updating

work_instruction

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

name

The "on what"

string

Required

Max length: 4000

status

Status can be Ok,NotOk,Replaced,NotApplicable

string

Max length: 50

date_done

Datetime filled when status goes to one valable status.

date
remark

Additional remark from the technician.

string

Max length: 255

advise

Additional advice from the technician.

string

Max length: 255

sequence

To order it.

integer
reference_back_office

The Id/Ref of the back office for this job work instruction. Used by Embedded entity

string

Max length: 255

group_name

Name of the group

string

Max length: 4000

group_sequence

Order of the group

integer
type

One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default

string
instruction_document_count

Specify how many documents/photos must be added if type is Picture

integer
db_report_type_id

When type is Form, you must specify which db_report_type must be filled

globally unique identifier
db_report_type_name

When type is Form, you must specify which db_report_type must be filled

string
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Request Formats :

application/json, text/json

Sample:
{
  "id": "6cf4b201-99f0-4fbc-8efe-757552ffb17a",
  "jobs_id": "9e5d300c-ab49-4a15-9bc5-0627479873ad",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "848e64c6-6905-4da4-a895-e713cd50c476",
    "_parent_id": "f5771256-67b3-4645-988a-6670c17c4ceb",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "1169c9be-edfd-4370-8253-1a2eeef1a78c",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "2335add1-3c63-4a5f-ab4d-772d72b0ea17",
      "_parent_id": "12e03553-6410-4be4-85fa-26dc41982251",
      "root_parent_id": "954db628-b814-4851-a349-fa57f1e0c060",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "237d617c-f260-4da9-8d16-8c764d790bfb",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "c7f2c55f-1671-4bd2-ac68-bb5f054d41d7",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "f52f1283-6a5c-483a-a089-13ca971c7410",
        "_parent_code": "sample string 6",
        "sales_organization_id": "11d17d30-f5e5-4460-9e7b-9b038ccd7eca",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "577304df-1553-4102-b427-c6189d224483",
          "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
          "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
        },
        "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
      },
      "equipment_model_id": "95f5c8de-4329-46d3-aff2-372b930a1a1b",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "c28cf5c0-ae64-4387-9b71-a8767602e456",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "ba674dda-9e38-4b0b-b434-e5ea501930b8",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "a564d7f5-6442-4fb1-ab0e-023f10e32a7b",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "85f34ee9-3a74-4a83-8f2e-4aa7fce26701",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "577304df-1553-4102-b427-c6189d224483",
            "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
            "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
          },
          "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
        },
        "equipment_family_id": "545dd72a-b9c8-4494-a515-4e9225fbb1bd",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "c7f2c55f-1671-4bd2-ac68-bb5f054d41d7",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "f52f1283-6a5c-483a-a089-13ca971c7410",
          "_parent_code": "sample string 6",
          "sales_organization_id": "11d17d30-f5e5-4460-9e7b-9b038ccd7eca",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "577304df-1553-4102-b427-c6189d224483",
            "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
            "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
          },
          "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
        },
        "date_in_production_since": "2025-10-26T06:34:41.0160462+00:00",
        "date_out_of_production_since": "2025-10-26T06:34:41.0160462+00:00",
        "date_end_support": "2025-10-26T06:34:41.0160462+00:00",
        "sales_organization_id": "71f8038d-3822-48c3-8e98-83b65f067702",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "577304df-1553-4102-b427-c6189d224483",
          "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
          "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
        },
        "replacement_period_nb_months": 14,
        "warranty_period_nb_months": 15,
        "translations": [
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          },
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          }
        ],
        "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
      },
      "project_status_id": "8ec18e2d-3030-4b3b-b397-5985062e8461",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "25c2db99-d9b4-44f6-b457-a4e7a477d531",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "35495622-e55f-47af-9b99-1f3f95297668",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "577304df-1553-4102-b427-c6189d224483",
          "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
          "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
      },
      "company_id": "66ae5f02-f6c2-4071-9c33-f4b80d865bab",
      "company_code": "sample string 12",
      "db_address_id": "ad9ba4da-b5bc-49d9-9cdd-7f8eef85da88",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "8fe8b0f6-f1ff-4aa9-a5ba-b995e9944812",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "b2eca0b9-0356-41b9-8c33-7add666e0c63",
      "name": "sample string 19",
      "description": "sample string 20",
      "reference_back_office": "sample string 21",
      "serial_number": "sample string 22",
      "barcode": "sample string 23",
      "date_start_production": "2025-10-26T06:34:41.0316688+00:00",
      "date_create": "2025-10-26T06:34:41.0316688+00:00",
      "date_update": "2025-10-26T06:34:41.0316688+00:00",
      "updated_by_user_id": "b801d170-7add-4259-a8b4-79026404087e",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-10-26T06:34:41.0316688+00:00",
      "last_standard_result_score_1": "sample string 30",
      "last_standard_result_score_2": "sample string 31",
      "target_standard_result_score_1": "sample string 32",
      "target_standard_result_score_2": "sample string 33",
      "date_built": "2025-10-26T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-10-26T06:34:41.0316688+00:00",
      "date_last_job": "2025-10-26T06:34:41.0316688+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-10-26T06:34:41.0316688+00:00",
      "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "0942d63d-1175-43b6-86cf-ef9b42ca2a33",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "70576b3d-2170-4fa0-a5e6-f2bcfc2b2045",
      "name": "sample string 2",
      "sales_organization_id": "6bbe1a28-32e4-4dbc-801e-33ca525b53f1",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "d4c4981b-4aaa-42be-ae06-248ea75396fd",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "5af8fd94-6b9c-461c-9e76-bc76669fd145",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "c8e13eb6-48b1-4c6d-806d-f1106cfc21a2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "577304df-1553-4102-b427-c6189d224483",
        "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
        "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
    },
    "job_status_id": "3288c9c9-7e4c-499c-9a90-6edbcf2c078e",
    "job_status_code": "sample string 11",
    "db_address_id": "401814bb-8673-4c2e-b4e2-3b9a76afa713",
    "contact_id": "b832366e-7d33-4349-9150-7855ac04e12e",
    "requested_by_company_id": "153138f3-925a-4fa1-b6e1-01653f4d5dd1",
    "requested_by_contact_id": "bb55b75e-a9cf-448c-b0eb-dd878ee6fe6e",
    "reference_back_office": "sample string 16",
    "name": "sample string 17",
    "description": "sample string 18",
    "working_sequence": 19,
    "internal_memo": "sample string 20",
    "prejob_information": "sample string 21",
    "estimated_time": 22,
    "earliest_date_plannable": "2025-10-26T06:34:41.0316688+00:00",
    "due_date": "2025-10-26T06:34:41.0316688+00:00",
    "date_create": "2025-10-26T06:34:41.0316688+00:00",
    "date_update": "2025-10-26T06:34:41.0316688+00:00",
    "date_closed": "2025-10-26T06:34:41.0316688+00:00",
    "suggested_user_id": "9f05583f-84e8-43d9-998b-b05f4deebe81",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "03fdb27a-f223-4809-a6f4-7f75607d74d0",
      "db_language_id": "ecc949b0-10e4-4f14-9472-1ccdefe8eccb",
      "username": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "code": "sample string 6",
      "archived": true,
      "disabled": true,
      "emergency_contact": "sample string 9",
      "bankaccount": "sample string 10",
      "social_security": "sample string 11",
      "place_of_birth": "sample string 12",
      "nationality": "sample string 13",
      "functions": "sample string 14",
      "birthdate": "2025-10-26T06:34:41.0316688+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "88a61397-8b3f-44c7-8d67-293fcf039e5b",
      "sales_organization": {
        "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "577304df-1553-4102-b427-c6189d224483",
        "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
        "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "1d734b38-b0c7-4e9d-9f65-0eb7d0cd63fb",
      "email": "sample string 22",
      "phone": "sample string 23",
      "fax": "sample string 24",
      "mobile": "sample string 25",
      "private_email": "sample string 26",
      "private_phone": "sample string 27",
      "private_fax": "sample string 28",
      "private_mobile": "sample string 29",
      "private_street": "sample string 30",
      "private_street_number": "sample string 31",
      "private_city": "sample string 32",
      "private_zip": "sample string 33",
      "private_db_country_id": "84e12d62-af0e-40fb-adce-381f9e1afbb9",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "7fa744cb-f202-4976-aa2a-3ba60c37c5c9"
    },
    "suggested_date_start": "2025-10-26T06:34:41.0316688+00:00",
    "skill_id": "49aaaedd-e15e-4677-9026-2776a3e948f3",
    "skill_code": "sample string 32",
    "skill": {
      "id": "d599f94a-8bd9-45f8-823c-700d7242c180",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "f4cfa44c-68d7-49bd-b526-8732a9806b25",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3fccb9d4-10bf-4032-8d91-4472d11ad22b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "577304df-1553-4102-b427-c6189d224483",
        "db_currency_id": "317ef0be-74b1-46fd-9a63-643a627f0ca6",
        "db_language_id": "4f72b90e-245e-4e55-947a-b64e25724d2b",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-26T06:34:41.0160462+00:00"
      },
      "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "2e239714-1a09-434d-84e2-cb98e49f765e",
    "date_reported_by_company": "2025-10-26T06:34:41.0316688+00:00",
    "id2": 36,
    "company_id": "a70d4e67-331a-4e8e-ae7e-9f0640fde368",
    "company_code": "sample string 38",
    "db_address_name": "sample string 39",
    "db_address_street": "sample string 40",
    "db_address_street2": "sample string 41",
    "db_address_street_number": "sample string 42",
    "db_address_city": "sample string 43",
    "db_address_zip": "sample string 44",
    "db_address_db_country_id": "5a0d728b-8540-4791-916b-5503156d32a9",
    "db_address_db_country_code": "sample string 46",
    "db_address_phone": "sample string 47",
    "db_address_email": "sample string 48",
    "db_address_latitude_decimal": 49.0,
    "db_address_longitude_decimal": 50.0,
    "estimated_quantity_remark": "sample string 51",
    "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
  },
  "work_instruction_details_id": "ef36408b-d65f-4c6b-a7cb-f44677cb6106",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "4068019c-c169-4f67-ad00-8322db9477ca",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "49c8bf63-3cce-4966-9073-3749c70d69d4",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-10-26T06:34:41.0316688+00:00",
  "remark": "sample string 13",
  "advise": "sample string 14",
  "sequence": 1,
  "reference_back_office": "sample string 15",
  "group_name": "sample string 16",
  "group_sequence": 1,
  "type": "sample string 17",
  "instruction_document_count": 1,
  "db_report_type_id": "11be6994-3100-4b0d-80e0-5379ffb0179f",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-10-26T06:34:41.0316688+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.