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": "1658fea1-f454-46a9-bfe6-b41d8d4237ca",
  "jobs_id": "f004455b-9a04-43d5-ae23-87f3e01ad039",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "bcff4071-e436-4f7a-9fa6-7ee54aaa6e8d",
    "_parent_id": "28015009-ee7f-4e42-b285-b06e3adf9ea8",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "3449fc2f-2be4-449b-824e-24374bd8da6b",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "74b4b107-73e5-4bf1-98a0-ac7adb3501da",
      "_parent_id": "1c38c2a7-b043-465d-82b8-5197a9fe2655",
      "root_parent_id": "9034d460-b3d2-4052-b619-64038735095c",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "a1b94866-c833-4bc5-9d35-fc68367937b3",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "a6bd2aef-dec0-4df4-bed6-a5fa5c6cd181",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "57979729-480b-455a-b08e-7d8957ec449a",
        "_parent_code": "sample string 6",
        "sales_organization_id": "58ceed9d-3066-4b04-84de-32e0a76e7cd0",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
          "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
          "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
          "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-07-09T15:45:58.9057666+00:00"
        },
        "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
      },
      "equipment_model_id": "ddade3b9-5996-44bd-9d5d-b7b3fe9225d4",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "7416cb93-1563-49e3-8042-46066bf7891f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "08d079ed-5358-48b6-847e-78dcf906fc4e",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "2628e9a1-4390-47ef-9c61-87942c7d414d",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "7b129338-8e1a-4444-ad09-10740d1adc40",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
            "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
            "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
            "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-07-09T15:45:58.9057666+00:00"
          },
          "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
        },
        "equipment_family_id": "2a8d9ff1-d68c-4820-8f74-d2cc89e37eca",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "a6bd2aef-dec0-4df4-bed6-a5fa5c6cd181",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "57979729-480b-455a-b08e-7d8957ec449a",
          "_parent_code": "sample string 6",
          "sales_organization_id": "58ceed9d-3066-4b04-84de-32e0a76e7cd0",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
            "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
            "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
            "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-07-09T15:45:58.9057666+00:00"
          },
          "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
        },
        "date_in_production_since": "2025-07-09T15:45:58.9057666+00:00",
        "date_out_of_production_since": "2025-07-09T15:45:58.9057666+00:00",
        "date_end_support": "2025-07-09T15:45:58.9057666+00:00",
        "sales_organization_id": "01a0ffe2-d372-4ac1-a07a-6c27953be13c",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
          "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
          "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
          "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-07-09T15:45:58.9057666+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-07-09T15:45:58.9057666+00:00"
      },
      "project_status_id": "61de4229-9262-4afc-89ab-3be46a314c44",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "f9d1223d-cf6a-4937-b107-d8619214fc86",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "fed9dbd3-0bdf-4bae-88e4-d09322ef5717",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
          "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
          "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
          "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-07-09T15:45:58.9057666+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
      },
      "company_id": "fd3361c0-8376-452c-ae6d-4df725d95960",
      "company_code": "sample string 12",
      "db_address_id": "cb14ae2c-d3ae-4b1b-8ece-820d77f2a8e9",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "960c24c7-d80e-4ef9-a169-b4bf26c5d8e8",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "546c6aa5-cec3-4f2c-832f-941e97cd4404",
      "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-07-09T15:45:58.9057666+00:00",
      "date_create": "2025-07-09T15:45:58.9057666+00:00",
      "date_update": "2025-07-09T15:45:58.9057666+00:00",
      "updated_by_user_id": "99810dd3-0cd4-4349-94d5-8a89204454eb",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-09T15:45:58.9057666+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-07-09T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-09T15:45:58.9057666+00:00",
      "date_last_job": "2025-07-09T15:45:58.9057666+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-09T15:45:58.9057666+00:00",
      "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "61edda97-59ae-4ea1-bc8f-71cabf7cf711",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "37e35e69-1a25-4bb7-b46c-307531ad6016",
      "name": "sample string 2",
      "sales_organization_id": "84ea83bc-9fd4-454c-a961-547f9cf23749",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "046cb6a6-b364-4513-991c-948332fef20c",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "00fd504e-2c90-40a5-a2f9-fd55d2e81def",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "62781784-abb3-4d79-bb34-b1ebe99b7a90",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
        "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
        "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
        "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-07-09T15:45:58.9057666+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
    },
    "job_status_id": "fd60f02b-e68a-4452-b8a6-840d9363ecdf",
    "job_status_code": "sample string 11",
    "db_address_id": "0f832e19-920d-4ec3-899f-46889d2b5020",
    "contact_id": "5051a502-665f-49b0-817c-9bce88319f5a",
    "requested_by_company_id": "d43b5eca-fc6a-490a-847c-12dac09558f3",
    "requested_by_contact_id": "953fed58-c573-491e-9ed9-5f623f45c702",
    "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-07-09T15:45:58.9057666+00:00",
    "due_date": "2025-07-09T15:45:58.9057666+00:00",
    "date_create": "2025-07-09T15:45:58.9057666+00:00",
    "date_update": "2025-07-09T15:45:58.9057666+00:00",
    "date_closed": "2025-07-09T15:45:58.9057666+00:00",
    "suggested_user_id": "a79c8d85-6831-4a4d-903d-efe1d821316c",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "fb623748-e9c6-4683-be3f-ddf11142e4aa",
      "db_language_id": "fc39ba88-b07c-4350-8b75-2ee260de18d1",
      "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-07-09T15:45:58.9057666+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "6ded88d2-4602-43fc-aa98-a823cff412e2",
      "sales_organization": {
        "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
        "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
        "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
        "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-07-09T15:45:58.9057666+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "c8840e8b-ac7b-465b-a330-fe9efe8563bf",
      "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": "854b11fb-7794-44d7-9d5b-7b9ea5e88865",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "203e977c-80fd-4d02-9391-1429f0fcf7b0"
    },
    "suggested_date_start": "2025-07-09T15:45:58.9057666+00:00",
    "skill_id": "324445c8-6bc3-407f-bc49-1d6ad8283bc7",
    "skill_code": "sample string 32",
    "skill": {
      "id": "e0e2cf74-55a0-421b-936b-d19da306e732",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "4c5e6d7d-70e0-45b1-b077-7a5e6a6c5c7b",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "1248dcfb-676f-44f4-a7c1-0a10247d0522",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "cc95fb19-c391-4172-bcc8-541015c73ffd",
        "db_currency_id": "e2696f42-26d5-444d-91ac-e96370b9c016",
        "db_language_id": "6a38c6e5-5347-49fa-a1a5-9c23b906f674",
        "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-07-09T15:45:58.9057666+00:00"
      },
      "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "a252fdcb-9491-45b2-9b61-6143d3d05659",
    "date_reported_by_company": "2025-07-09T15:45:58.9057666+00:00",
    "id2": 36,
    "company_id": "6a928871-fa3f-4768-9383-9438c8aa0576",
    "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": "fbf147f2-b5be-4624-95f7-5dc07f9fa8a4",
    "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-07-09T15:45:58.9057666+00:00"
  },
  "work_instruction_details_id": "ffacd6e2-f0c3-4177-958a-56117182d678",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "e2143214-ce73-4052-9701-ffddecb3b62c",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "9ca82825-e35f-4ba6-bceb-1b1c4fb2c510",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-09T15:45:58.9057666+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": "3bde19aa-5dd6-463e-a705-8ab2b724ed1f",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-09T15:45:58.9057666+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.