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": "ae77ffc7-d898-4861-a413-8f536f8dae2d",
  "jobs_id": "def25cad-ad17-4a6b-a252-ff358f2085a4",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "0d78dbd6-1513-4e98-bd93-57f93de6e641",
    "_parent_id": "b9cab0ef-6ef8-4909-ac0f-7b4c5e6d7ee5",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "a9c657a6-797b-4ed5-a00d-c1b7476e22f1",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "d6d3ff5f-6a59-4c13-803d-e8c3589e0435",
      "_parent_id": "4813b806-98f0-4e8a-878f-6456b817b80e",
      "root_parent_id": "c0cb6357-ffd0-4994-a040-330093c51c99",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "81ec5c2c-2988-41c6-8ff1-bf36e841ae74",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "8532e6ae-0428-4929-9a23-14168b1c3762",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "d62b7cd6-f880-4fe2-8b40-28c48a7b254b",
        "_parent_code": "sample string 6",
        "sales_organization_id": "df8718b5-dc7c-4243-bef5-008cea03eb40",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
          "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
          "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
          "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-18T02:55:00.6959998+00:00"
        },
        "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
      },
      "equipment_model_id": "1c401997-529a-48e4-a5c1-d005912a4921",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "893ac647-823d-4391-a7c1-94df0194634e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "61e26729-07e5-41b3-9667-8e90f350f3b4",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "73d99229-4f36-42b3-810b-adb346f04819",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "9b08c410-8d53-4d9c-bb03-e73efaa31244",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
            "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
            "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
            "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-18T02:55:00.6959998+00:00"
          },
          "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
        },
        "equipment_family_id": "5dc8547f-6bd0-4e1a-ab9b-902e7cc6b673",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "8532e6ae-0428-4929-9a23-14168b1c3762",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "d62b7cd6-f880-4fe2-8b40-28c48a7b254b",
          "_parent_code": "sample string 6",
          "sales_organization_id": "df8718b5-dc7c-4243-bef5-008cea03eb40",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
            "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
            "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
            "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-18T02:55:00.6959998+00:00"
          },
          "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
        },
        "date_in_production_since": "2025-07-18T02:55:00.6959998+00:00",
        "date_out_of_production_since": "2025-07-18T02:55:00.6959998+00:00",
        "date_end_support": "2025-07-18T02:55:00.6959998+00:00",
        "sales_organization_id": "31f28798-e561-4fe9-807b-a4d4bca8f810",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
          "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
          "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
          "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-18T02:55:00.6959998+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-18T02:55:00.6959998+00:00"
      },
      "project_status_id": "fb15d9ae-5c79-4436-93bb-649e93555380",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "81656593-9c04-4442-9f1f-a77d3ff9aa9f",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "8c471c68-6d2e-4938-9a18-2a83051a0524",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
          "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
          "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
          "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-18T02:55:00.6959998+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
      },
      "company_id": "55714ced-96d4-42db-aaa1-947764977e78",
      "company_code": "sample string 12",
      "db_address_id": "9ab9d870-2493-47d6-8af9-904ea1e8a006",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "6abf3baf-d2a6-44a0-b7ac-860aaa3511e8",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "7219f5e7-7d6b-4b4a-8632-a90cff53eccf",
      "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-18T02:55:00.6959998+00:00",
      "date_create": "2025-07-18T02:55:00.6959998+00:00",
      "date_update": "2025-07-18T02:55:00.6959998+00:00",
      "updated_by_user_id": "d37cbe49-3f8a-4f92-b89d-74493e821322",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-18T02:55:00.6959998+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-18T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-18T02:55:00.6959998+00:00",
      "date_last_job": "2025-07-18T02:55:00.6959998+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-18T02:55:00.6959998+00:00",
      "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "a4d3d0dd-4a38-42ad-8f02-95efc2355d3c",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "468d3a8d-55aa-4aa7-bb11-8c6a289e6453",
      "name": "sample string 2",
      "sales_organization_id": "daa0ef84-b5fc-470f-9659-14ddef6d4583",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "6fff55e5-155a-4ee4-8977-674f70bec59b",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "3b3cecd4-505e-459b-ae07-4c0d12127c24",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "7ff7d8da-3b4d-4bbb-b3ed-0508dcc41ddb",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
        "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
        "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
        "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-18T02:55:00.6959998+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
    },
    "job_status_id": "8198d93b-6a70-43ec-9a4c-fdc69c224271",
    "job_status_code": "sample string 11",
    "db_address_id": "67dae551-1077-417b-bb97-8c7adebfaa83",
    "contact_id": "9df15242-7db4-4fb6-94fd-8745a0bf1793",
    "requested_by_company_id": "ea3b6447-5f68-4e08-a128-97679d87de12",
    "requested_by_contact_id": "2a134b76-83e4-4733-8d03-0dcdf4b167b4",
    "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-18T02:55:00.6959998+00:00",
    "due_date": "2025-07-18T02:55:00.6959998+00:00",
    "date_create": "2025-07-18T02:55:00.6959998+00:00",
    "date_update": "2025-07-18T02:55:00.6959998+00:00",
    "date_closed": "2025-07-18T02:55:00.6959998+00:00",
    "suggested_user_id": "3e65c9b2-e1dd-46b1-8b56-29cd427c72ac",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "737c7dbc-f539-48aa-93bd-c81c58c192db",
      "db_language_id": "3c49c5d6-a85d-474d-8a06-e7a926e2d81f",
      "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-18T02:55:00.6959998+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "9d7c250f-e376-44e2-8c9d-6c93b5d19165",
      "sales_organization": {
        "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
        "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
        "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
        "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-18T02:55:00.6959998+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "edefcbd3-5c6b-41c2-b1c0-78a546f3cc7d",
      "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": "5452e048-96c9-4682-bc50-ec8c4a407699",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "f010139a-61ae-402f-beb1-e711443e870d"
    },
    "suggested_date_start": "2025-07-18T02:55:00.6959998+00:00",
    "skill_id": "eaca26b5-9369-40f6-a06f-50852df9c694",
    "skill_code": "sample string 32",
    "skill": {
      "id": "4c1af12e-c37f-4220-88e6-c8b9d43751a2",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "09b39638-c50e-4af4-9335-a80f92ff76dc",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "23574aeb-e66c-405e-9a8c-0ffcd7d7e982",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1ce0413a-9197-4e06-a3bf-eeaf67fd9170",
        "db_currency_id": "4ba0983c-f1bc-4313-8368-453e87fb1116",
        "db_language_id": "162ef74e-9ade-4d3d-ae2e-afdac5d12643",
        "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-18T02:55:00.6959998+00:00"
      },
      "modified_dateutc": "2025-07-18T02:55:00.6959998+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "0d732b04-63e3-4f25-8220-540e6146a5b9",
    "date_reported_by_company": "2025-07-18T02:55:00.6959998+00:00",
    "id2": 36,
    "company_id": "fcb1aa3e-3677-4835-8ea0-26a9c4b2e128",
    "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": "5afd5044-4f98-44e6-abbf-e7ec83b691f3",
    "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-18T02:55:00.6959998+00:00"
  },
  "work_instruction_details_id": "52a704f4-6d3a-4c4a-9481-6c1c8bea7a42",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "0985a525-b505-407e-a63f-d5e098cc2b92",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "2b7855d3-c359-4715-9582-1b70fca98e81",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-18T02:55:00.6959998+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": "5a9c480a-8be6-4301-8850-f8a6839e8231",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-18T02:55:00.711643+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.