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": "7f03a3dc-e26c-4ef6-bc9c-b6c41cef43de",
  "jobs_id": "37543158-b903-49ad-8dd9-1dcd9ee5330f",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "72954b02-756a-4aca-abdb-e39bfa71b393",
    "_parent_id": "054fd223-cab0-456a-8cae-6cf8e70de246",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "6655b837-5ffb-4201-bc46-1cae3daef14c",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "62854489-54f5-4cc3-aac1-0f1ef0929c91",
      "_parent_id": "e20349f2-7678-4378-a8e8-96288f78fdd4",
      "root_parent_id": "7c72f364-b0d6-4cd5-a012-e9b5fd7a2c1b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "d46d0525-991a-4cb1-bb05-b9dacae34100",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "cb2ec235-70e8-4036-934e-dfbc503a3c2d",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "28e5a3f7-1aa7-4861-afb4-e7ab68e718d9",
        "_parent_code": "sample string 6",
        "sales_organization_id": "e30b7308-c0f0-4c92-b3fc-a2666aecbc56",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
          "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
          "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
          "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": "2026-11-17T10:17:25.6042693+00:00"
        },
        "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
      },
      "equipment_model_id": "17142146-3e26-4caa-b073-2de69e12d429",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "80fa9898-4370-417f-a827-08e8d44220ba",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "fec36a7e-5cb8-4a7e-99e7-cafb0460256f",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "820e5502-18e7-4711-9a38-e1d8da81983c",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "0b56e878-a6ff-4076-a3e4-e57ff6a4361c",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
            "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
            "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
            "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": "2026-11-17T10:17:25.6042693+00:00"
          },
          "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
        },
        "equipment_family_id": "a812cbdb-9297-4ebf-9e24-db3e57992d55",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "cb2ec235-70e8-4036-934e-dfbc503a3c2d",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "28e5a3f7-1aa7-4861-afb4-e7ab68e718d9",
          "_parent_code": "sample string 6",
          "sales_organization_id": "e30b7308-c0f0-4c92-b3fc-a2666aecbc56",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
            "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
            "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
            "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": "2026-11-17T10:17:25.6042693+00:00"
          },
          "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
        },
        "date_in_production_since": "2026-11-17T10:17:25.6042693+00:00",
        "date_out_of_production_since": "2026-11-17T10:17:25.6042693+00:00",
        "date_end_support": "2026-11-17T10:17:25.6042693+00:00",
        "sales_organization_id": "1e6b15d6-baa2-44ee-9918-5f410fd996f0",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
          "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
          "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
          "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": "2026-11-17T10:17:25.6042693+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": "2026-11-17T10:17:25.6042693+00:00"
      },
      "project_status_id": "47edb6c3-75af-47df-9d2a-bab523347b31",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "567adaa4-f7e7-4531-b660-5df93bf2d0d8",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "b4b24122-13b3-43d4-aebb-a9960e828dfa",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
          "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
          "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
          "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": "2026-11-17T10:17:25.6042693+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
      },
      "company_id": "f969c6bf-f472-48f4-81d7-7a381a587a27",
      "company_code": "sample string 12",
      "db_address_id": "d9eecbd9-4032-487a-8577-ae50556ec009",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "70e98103-7e65-46d9-a391-040cf1d15838",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "c48441f2-6ba0-497b-9ebe-eb52afbb894b",
      "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": "2026-11-17T10:17:25.6042693+00:00",
      "date_create": "2026-11-17T10:17:25.6042693+00:00",
      "date_update": "2026-11-17T10:17:25.6042693+00:00",
      "updated_by_user_id": "0dee8dfd-3bb0-4e04-a379-6d29ac9042ed",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-17T10:17:25.6042693+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": "2026-11-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-17T10:17:25.6042693+00:00",
      "date_last_job": "2026-11-17T10:17:25.6042693+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-17T10:17:25.6042693+00:00",
      "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5a9c5c9e-e149-4641-90ee-a21e6d7610f2",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "56caf315-93ae-4b8f-b00e-c51e5947242c",
      "name": "sample string 2",
      "sales_organization_id": "a30e3026-b0e4-4b3e-9105-b1295ca56a88",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "d713a4c0-e580-47ed-baf3-925d36937570",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "15b9dcec-db69-4cdd-aec8-cd6a9f41f1cb",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "85862c6d-2935-491c-8a34-6e2181f24c48",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
        "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
        "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
        "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": "2026-11-17T10:17:25.6042693+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
    },
    "job_status_id": "9cef3e39-72b8-4c78-810b-1203a11c440c",
    "job_status_code": "sample string 11",
    "db_address_id": "a26bd640-33fc-4bf7-bcc8-50911fe7faa2",
    "contact_id": "7bbd517c-4a91-4d8d-9937-746f30d16e02",
    "requested_by_company_id": "eca62df4-1b19-4be0-83ed-fc74484e41ab",
    "requested_by_contact_id": "e024d34e-b9fa-45ab-a8a7-1b4416df9001",
    "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": "2026-11-17T10:17:25.6042693+00:00",
    "due_date": "2026-11-17T10:17:25.6042693+00:00",
    "date_create": "2026-11-17T10:17:25.6042693+00:00",
    "date_update": "2026-11-17T10:17:25.6042693+00:00",
    "date_closed": "2026-11-17T10:17:25.6042693+00:00",
    "suggested_user_id": "63a6ed49-08df-4711-800f-b0d0cafb2823",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "4ae1a937-b542-4856-9e2f-688e2c28c6ee",
      "db_language_id": "de08e152-515e-48e4-b125-cac7d6ed809d",
      "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": "2026-11-17T10:17:25.6042693+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "367e76ea-bbc8-4e8a-9e1a-38bd82e68354",
      "sales_organization": {
        "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
        "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
        "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
        "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": "2026-11-17T10:17:25.6042693+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "998fe518-015d-48d0-86b9-84a0275abffe",
      "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": "b4493cce-8760-4f14-8ee1-304959220a6a",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "50aad5fe-c3a8-437a-8ace-bf0e7dcaae1e"
    },
    "suggested_date_start": "2026-11-17T10:17:25.6042693+00:00",
    "skill_id": "c5adfb50-d623-4ac7-b3f6-73390fb499b8",
    "skill_code": "sample string 32",
    "skill": {
      "id": "1a98178d-d3bb-4d1c-b67a-aaa1f5287069",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "a533b882-06fb-4bf9-939d-51b0cdd9cca7",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "0197c440-83c2-4fa9-933f-47430f3e598e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "194fbba6-82b1-4a6d-9e3e-4d11c5708f38",
        "db_currency_id": "eb064b19-4c0f-46fe-80a7-4b2606721179",
        "db_language_id": "ea389317-f1e4-49b0-867e-103cd25ed8c8",
        "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": "2026-11-17T10:17:25.6042693+00:00"
      },
      "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "fa686833-68da-4b99-a5a8-7833c9671c25",
    "date_reported_by_company": "2026-11-17T10:17:25.6042693+00:00",
    "id2": 36,
    "company_id": "00ff585c-4d9f-4be9-b044-7347db1ed00c",
    "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": "c77ca114-10a1-4613-a8bc-bc9a323e2988",
    "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": "2026-11-17T10:17:25.6042693+00:00"
  },
  "work_instruction_details_id": "8e85a645-3816-4b60-bf51-4d25ed5a96d5",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "09a5e3be-48bd-49cf-87db-e39f1d58476b",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "00387108-4574-4ec7-aa9a-986226ef046d",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-17T10:17:25.6042693+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": "713faaef-967f-4814-8c72-5f6ee05d3fb8",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-17T10:17:25.6042693+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.