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": "fb64e9d2-7791-4931-801c-38801ed569db",
  "jobs_id": "04513b6d-fea0-40b6-b768-08316e10e353",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "78a745ca-0f36-4f91-b66f-dcbdf3dcd41e",
    "_parent_id": "50e7447d-5814-4028-9f5d-3b2c5b6b52f6",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "0161d366-adad-44cf-93aa-ac2285eb1583",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "3c7f1dde-8319-4db4-9438-ed2b26ded7fa",
      "_parent_id": "f0581730-db5a-482f-876e-fe6d1a72dc34",
      "root_parent_id": "b898d17f-0416-4867-9ed8-803392783fac",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "9326ba5e-0920-44c4-83ad-cf46201bf392",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "fc72d704-f84e-448f-afad-45b50e1f829c",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "1c18fa5c-83c3-4342-94cc-536f9df0b783",
        "_parent_code": "sample string 6",
        "sales_organization_id": "97e7ed84-94b3-446b-b49a-210f2997851e",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
          "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
          "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
          "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-19T00:00:19.5189815+00:00"
        },
        "modified_dateutc": "2025-07-19T00:00:19.5189815+00:00"
      },
      "equipment_model_id": "1c4ed192-31b5-48de-a220-018ca6a30228",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f210baae-84fe-45d7-bd3f-660feb88af11",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "20426dcd-0078-4331-9e4c-6c5607c2e8d8",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "8bfa6d98-21d6-4cf9-8c4b-07125d95e530",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "33c05d57-660d-4aa9-8f6c-b488b473eeec",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
            "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
            "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
            "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-19T00:00:19.5189815+00:00"
          },
          "modified_dateutc": "2025-07-19T00:00:19.5189815+00:00"
        },
        "equipment_family_id": "4d0523cb-978f-4416-b868-f1079ea895ca",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "fc72d704-f84e-448f-afad-45b50e1f829c",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "1c18fa5c-83c3-4342-94cc-536f9df0b783",
          "_parent_code": "sample string 6",
          "sales_organization_id": "97e7ed84-94b3-446b-b49a-210f2997851e",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
            "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
            "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
            "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-19T00:00:19.5189815+00:00"
          },
          "modified_dateutc": "2025-07-19T00:00:19.5189815+00:00"
        },
        "date_in_production_since": "2025-07-19T00:00:19.5189815+00:00",
        "date_out_of_production_since": "2025-07-19T00:00:19.5189815+00:00",
        "date_end_support": "2025-07-19T00:00:19.5189815+00:00",
        "sales_organization_id": "63570a4c-5f56-48a9-8430-fb3cec7db60a",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
          "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
          "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
          "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-19T00:00:19.5189815+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-19T00:00:19.5189815+00:00"
      },
      "project_status_id": "65dfc335-4e5d-4c73-a5a0-2e7a2c7d61ac",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "08f36536-c73d-4e31-b3a0-f61a4bd96a75",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "992f5425-2394-41d1-886e-10652aa601c8",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
          "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
          "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
          "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-19T00:00:19.5189815+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-19T00:00:19.5346083+00:00"
      },
      "company_id": "83ae37cd-271d-4c24-a23b-a00462f34aef",
      "company_code": "sample string 12",
      "db_address_id": "2c5d9aec-f043-4619-b04e-3e6e6340ba70",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "7892081b-18af-4573-92ca-6e347a2c4296",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "d22b8fd3-a358-4b71-b983-15a83d627f65",
      "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-19T00:00:19.5346083+00:00",
      "date_create": "2025-07-19T00:00:19.5346083+00:00",
      "date_update": "2025-07-19T00:00:19.5346083+00:00",
      "updated_by_user_id": "f5fb9c29-f498-4a4c-a9e7-283447dfc884",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-19T00:00:19.5346083+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-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-19T00:00:19.5346083+00:00",
      "date_last_job": "2025-07-19T00:00:19.5346083+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-19T00:00:19.5346083+00:00",
      "modified_dateutc": "2025-07-19T00:00:19.5346083+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "e147fc67-cbd0-4418-8e3d-57bf766c7e1a",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "0bd17131-4494-48ee-be9b-b590887ab742",
      "name": "sample string 2",
      "sales_organization_id": "24340c47-c13e-4f38-ba3a-727508cdd6b3",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-19T00:00:19.5346083+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "79ee15b7-2257-468f-ac32-98a1fdbfe5ff",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c8bb5206-608d-434c-aaf3-b7e5a7de1376",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "82c071db-a47b-4106-bab5-6142ecf27f2b",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
        "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
        "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
        "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-19T00:00:19.5189815+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-19T00:00:19.5346083+00:00"
    },
    "job_status_id": "41593755-7470-408e-9e5e-ba0a97222ee0",
    "job_status_code": "sample string 11",
    "db_address_id": "b6d5a5aa-7ef9-40e0-862c-6d48b7b2aaac",
    "contact_id": "fa33b271-fd5e-4789-906b-8e3f898870f1",
    "requested_by_company_id": "60aa7b53-11f7-47b8-bfe2-cf40fb240e3e",
    "requested_by_contact_id": "9a1cf3a3-deb6-4bf0-a097-db818fd460fb",
    "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-19T00:00:19.5346083+00:00",
    "due_date": "2025-07-19T00:00:19.5346083+00:00",
    "date_create": "2025-07-19T00:00:19.5346083+00:00",
    "date_update": "2025-07-19T00:00:19.5346083+00:00",
    "date_closed": "2025-07-19T00:00:19.5346083+00:00",
    "suggested_user_id": "739ba9e0-c10d-4da4-82f8-6c33aa3a392a",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "427feb05-caea-487a-9688-1ab8e8d979e8",
      "db_language_id": "c9f0434a-7a74-4c8e-bb12-49cdca8c6bea",
      "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-19T00:00:19.5346083+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "75be482e-809d-4f84-b00a-a2d9c48153d6",
      "sales_organization": {
        "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
        "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
        "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
        "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-19T00:00:19.5189815+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "44795d5d-1476-43e2-968b-eda893713d79",
      "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": "7d895aef-fa45-46bd-9a35-5232a09b42db",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-19T00:00:19.5502375+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "95a1aff5-943e-4f76-90ca-dfed4ffdf29f"
    },
    "suggested_date_start": "2025-07-19T00:00:19.5502375+00:00",
    "skill_id": "51a8eb6a-66f7-431c-95c5-5c2a4f884ad5",
    "skill_code": "sample string 32",
    "skill": {
      "id": "f56fce5d-8610-4671-85e9-9fa84d953584",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "91a4ec49-b5cb-4dc2-ab29-aabec79abd51",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "1ac2d8f6-ae05-4ce2-b957-86050cb22a48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "e76b9ea0-05d4-4490-b43d-206954264775",
        "db_currency_id": "ea69c0c1-b1ff-4095-9293-f53c51c45451",
        "db_language_id": "ba4b53d9-b100-4584-99a3-747975e9b955",
        "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-19T00:00:19.5189815+00:00"
      },
      "modified_dateutc": "2025-07-19T00:00:19.5502375+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "5ed22590-ebce-4454-bedd-6cc45c62f88f",
    "date_reported_by_company": "2025-07-19T00:00:19.5502375+00:00",
    "id2": 36,
    "company_id": "10eedb1d-f494-4f3e-bc2d-e903ae6732f5",
    "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": "92d90890-0e3b-4463-9960-d559e99f47e2",
    "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-19T00:00:19.5502375+00:00"
  },
  "work_instruction_details_id": "948c2b4b-4b92-4b95-8b1c-c18e65763eb9",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "d304c86e-bcee-4a6b-acdc-f0934b55634e",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "d97888b2-8911-4d9c-9013-361fdd9b83b9",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-19T00:00:19.5502375+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": "afdb71ed-933e-4b18-b8af-e30749197eaa",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-19T00:00:19.5658669+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.