Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional 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": "309bf805-727d-4277-bc5b-282e87499068",
"jobs_id": "92c69a3e-edb1-41a1-b0c8-b8cdedfc3a25",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "19e90665-2030-4de0-8141-01242e0e59af",
"_parent_id": "014bb2cd-1461-4771-897d-bcd18f9ad164",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c973c9cb-e6cc-46f2-9d88-81fa5af3b368",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4e90b584-1cc0-45bb-86c6-1b2fee350943",
"_parent_id": "f62f254e-9fae-474a-b6a8-d0372f6d6935",
"root_parent_id": "fc6fb154-8811-4b4f-9047-7ebfce68566c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5bae4ae5-db5d-4d0e-9956-1abadadc8a9d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53d7eebf-83b7-4ef6-bd1a-485a1d2f6a5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5036c99-90fb-4a96-afeb-9d617b8683a1",
"_parent_code": "sample string 6",
"sales_organization_id": "83086c27-2db5-4b65-b01c-6efde5b64f5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"equipment_model_id": "20dc2e16-78fa-471e-9c07-dfed8d9e29c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea959fc8-ea7e-41fb-9d23-860a859a5e72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "60cf9f63-4ddd-4eaf-aaf3-aee6a2e01fe0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0ebc94d3-9830-4834-a530-d71458b65d67",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dbb6e114-3d13-4f9d-b6f0-c549e1214e48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"equipment_family_id": "2dbe5d10-40a0-4667-aff7-74125e466201",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53d7eebf-83b7-4ef6-bd1a-485a1d2f6a5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5036c99-90fb-4a96-afeb-9d617b8683a1",
"_parent_code": "sample string 6",
"sales_organization_id": "83086c27-2db5-4b65-b01c-6efde5b64f5d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"date_in_production_since": "2026-01-30T14:09:33.1533857+00:00",
"date_out_of_production_since": "2026-01-30T14:09:33.1533857+00:00",
"date_end_support": "2026-01-30T14:09:33.1533857+00:00",
"sales_organization_id": "1c936aaa-5f55-4fa1-9212-47ec9ff79ef5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+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-01-30T14:09:33.1533857+00:00"
},
"project_status_id": "e2139363-6765-42f6-8aef-8408eb8b9975",
"project_status_code": "sample string 10",
"project_status": {
"id": "99d5dc1f-5a1f-4656-83b1-603e30f65586",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f47084dc-0b26-4876-9193-ee8e6f8e6a80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"company_id": "0fa193ca-9125-4061-9282-dea7dee11b15",
"company_code": "sample string 12",
"db_address_id": "8d1f5e2e-9986-4f30-8e6f-50bd4b90715e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "78a02d1d-0586-465d-966c-d96cea29f438",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f7f6cb9d-fb11-40b7-a378-432d13c75b88",
"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-01-30T14:09:33.1533857+00:00",
"date_create": "2026-01-30T14:09:33.1533857+00:00",
"date_update": "2026-01-30T14:09:33.1533857+00:00",
"updated_by_user_id": "84cc1834-0e50-4a8a-9891-7d309e42611f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-30T14:09:33.1533857+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-01-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-30T14:09:33.1533857+00:00",
"date_last_job": "2026-01-30T14:09:33.1533857+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-30T14:09:33.1533857+00:00",
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1f93edb-e242-41fa-a5d8-83e39b9fd225",
"job_type_code": "sample string 7",
"job_type": {
"id": "46c5de4e-0c71-4f28-8544-f2366ca07ee0",
"name": "sample string 2",
"sales_organization_id": "ba74b012-ff7d-4ea4-9520-f0afe12ca91a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00",
"code": "sample string 7"
},
"job_priority_id": "cbc41388-7060-48ff-8738-0d99bcafe31d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7eae70a2-965c-4003-81ae-af7a2ba02ce1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bd3f0000-bc1a-434a-8bf6-d88aaaa715a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"job_status_id": "b4e74e3a-8179-4439-8976-1bcdf4a235e2",
"job_status_code": "sample string 11",
"db_address_id": "8dd0d05b-42ab-4c02-a6aa-a701e9ca1c2c",
"contact_id": "4ad13582-9193-4a37-804f-114a7ca723e8",
"requested_by_company_id": "b63c1e5f-7b88-4c7c-92b4-613e676f58cc",
"requested_by_contact_id": "f0dcbcfa-8156-4c77-b1d9-784fa57d3bd6",
"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-01-30T14:09:33.1533857+00:00",
"due_date": "2026-01-30T14:09:33.1533857+00:00",
"date_create": "2026-01-30T14:09:33.1533857+00:00",
"date_update": "2026-01-30T14:09:33.1533857+00:00",
"date_closed": "2026-01-30T14:09:33.1533857+00:00",
"suggested_user_id": "ef890964-33ef-4c1f-81bc-dab154e72bc7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "432fa626-3e82-44bf-a0a0-ae9c40d6e4d7",
"db_language_id": "88e06bf7-9431-4e2e-88d8-ef3a0762ea38",
"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-01-30T14:09:33.1533857+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9bcbc4f6-c9c8-430c-acdb-3025173990d0",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0e699afb-c359-4cef-ae75-a037782c4097",
"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": "1da43a48-039b-4353-bfa9-a02f2ba3cab1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e42ce532-6f7d-4be5-aae2-999783607d5d"
},
"suggested_date_start": "2026-01-30T14:09:33.1533857+00:00",
"skill_id": "30768827-38ea-4755-948e-98e1d6dd99ab",
"skill_code": "sample string 32",
"skill": {
"id": "15afd532-1470-40d5-b089-0321f7c6a6b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ce9e57e5-7dd8-4a5b-962a-efd62ac2169d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e742ae67-7faa-4da2-9a94-d41dd0ae455f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef03c026-14c6-4f32-99a1-ebdb35da6004",
"db_currency_id": "8622469f-c123-48d1-b661-e8776c20e2d8",
"db_language_id": "1c50dff8-c9aa-45e2-ad26-2dc68be8ba5e",
"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-01-30T14:09:33.1533857+00:00"
},
"modified_dateutc": "2026-01-30T14:09:33.1533857+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e8594cf8-0cf4-4dcc-885c-3825a1c7eeb5",
"date_reported_by_company": "2026-01-30T14:09:33.1533857+00:00",
"id2": 36,
"company_id": "1461cf15-8e1c-47b5-a6a0-d6e4f92b400c",
"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": "d29cda42-0ea8-4114-a8e2-a368f1e5d57b",
"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-01-30T14:09:33.1533857+00:00"
},
"work_instruction_details_id": "159c84bf-e10e-438e-96ce-6d10bd5bc53a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "89d19f1d-3bdf-40f1-9508-601ffc3b8858",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7d11587a-b2c1-4a67-9c3d-8563d211c42e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-30T14:09:33.1533857+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": "455a21e1-0d55-43c7-aba6-7b77ebf0098e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-30T14:09:33.1690014+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.