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": "58032722-81b7-430b-a3a9-62a8b5a56108",
"jobs_id": "351ab114-0df2-46a0-927f-67f90e0607c5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1d4cf91b-2bae-4f81-93b7-b051da1a476e",
"_parent_id": "851bade0-4f06-48f3-985f-fb9546b0fd66",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1bc3a20-e194-4579-8e28-953d9489cff5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee78891a-4873-4c28-9304-31abd0674d12",
"_parent_id": "22788111-696d-426e-850e-5b2302ce6cbc",
"root_parent_id": "7b72601e-cbb5-43fe-ae7e-3c1fef2f65e5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "765ea5bc-5e64-4d20-84a2-57a672343a49",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cdc76bc1-f14b-46e4-a6fe-1fb4753c2508",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "458492d8-cd13-4045-86ba-29f6de99e1a7",
"_parent_code": "sample string 6",
"sales_organization_id": "7d0fe097-bdf4-4ccb-af04-17fa02e15d9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"equipment_model_id": "4e617e91-bdfa-4338-8db1-f83d3f2fa633",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eeb0bf40-252b-4d63-a299-7bafa4aac4af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a54c9963-3548-4fc6-b530-a613c227e3b9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b547790b-8f5e-44ed-97d7-8b196455044b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aa46edbe-dd84-4183-ae87-46675f3595bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"equipment_family_id": "acb26ea0-a2f9-47d8-8644-9155982b5437",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cdc76bc1-f14b-46e4-a6fe-1fb4753c2508",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "458492d8-cd13-4045-86ba-29f6de99e1a7",
"_parent_code": "sample string 6",
"sales_organization_id": "7d0fe097-bdf4-4ccb-af04-17fa02e15d9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"date_in_production_since": "2026-07-24T03:57:04.9561629+00:00",
"date_out_of_production_since": "2026-07-24T03:57:04.9561629+00:00",
"date_end_support": "2026-07-24T03:57:04.9561629+00:00",
"sales_organization_id": "7f2dd7b6-27e3-43ee-b66d-1a072d736118",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+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-07-24T03:57:04.9561629+00:00"
},
"project_status_id": "352f127c-edb9-46f1-9e0c-18260fb1adf1",
"project_status_code": "sample string 10",
"project_status": {
"id": "60f8dd6c-531f-4d77-8536-03e07a25bd15",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a8b62f9a-8735-4987-b2e2-b6a3dbf93eff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"company_id": "15540cc9-0b9f-4421-be15-49c906cfe516",
"company_code": "sample string 12",
"db_address_id": "a89a9436-aabc-416c-862b-909e8ab01dcb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c53d2540-a37d-4751-bd18-cc2c56367fc2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "32cf3e6a-123c-4995-9006-b1271273d083",
"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-07-24T03:57:04.9561629+00:00",
"date_create": "2026-07-24T03:57:04.9561629+00:00",
"date_update": "2026-07-24T03:57:04.9561629+00:00",
"updated_by_user_id": "ed7c0dca-eaf9-49b5-8186-863b790ee58d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T03:57:04.9561629+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-07-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T03:57:04.9561629+00:00",
"date_last_job": "2026-07-24T03:57:04.9561629+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T03:57:04.9561629+00:00",
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00",
"is_mobile_installation": true
},
"job_type_id": "5e04af4d-45b6-4c97-bfa4-a19b523f0ded",
"job_type_code": "sample string 7",
"job_type": {
"id": "efb951a5-3621-4eab-ad2e-275cdbf0862d",
"name": "sample string 2",
"sales_organization_id": "b1a78856-f5e7-4f12-bd60-e806f12e7f7d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00",
"code": "sample string 7"
},
"job_priority_id": "07f1a092-b34a-4b30-976e-89674ab98249",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e52e77f2-44f2-47c0-ae85-b8701b1b0488",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a063d391-3c60-432e-ae52-e991ac362d79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"job_status_id": "05dc9287-4b80-4465-99c0-a3f31063f963",
"job_status_code": "sample string 11",
"db_address_id": "4415a102-e57e-4b2a-8fa2-4a81b5138420",
"contact_id": "d2110d11-cace-4263-8134-d9919bd8b051",
"requested_by_company_id": "29d5287d-d4e5-4349-8d7a-b5e18de34bd6",
"requested_by_contact_id": "32a702db-77df-473f-97e5-b6e14a6504fe",
"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-07-24T03:57:04.9561629+00:00",
"due_date": "2026-07-24T03:57:04.9561629+00:00",
"date_create": "2026-07-24T03:57:04.9561629+00:00",
"date_update": "2026-07-24T03:57:04.9561629+00:00",
"date_closed": "2026-07-24T03:57:04.9561629+00:00",
"suggested_user_id": "94b9d9da-3fa6-4ef5-8810-61a28b68df0a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "93ff1178-b9e7-487f-8f7f-f0f68e58015b",
"db_language_id": "0a0ec359-688d-4cca-8b2e-8eb8e36574b6",
"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-07-24T03:57:04.9561629+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8fd7ba83-a1f5-4289-829b-22004603e0a2",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7fa92d6b-e59f-466e-a993-f7c0b5d82261",
"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": "7c1f9ca8-d766-4579-bd92-3f66805296e7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b2b08f5-c434-4148-a4e4-206ff64b9a64"
},
"suggested_date_start": "2026-07-24T03:57:04.9561629+00:00",
"skill_id": "e46c45bf-e425-4ff0-a888-872338f740f7",
"skill_code": "sample string 32",
"skill": {
"id": "5ecce70c-e005-4438-942c-bcb4ca36ec22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b175c9fd-d6d5-4d1e-bc7f-125199ec205b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e329157-3400-41ee-92b8-093a7fab1326",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ec8549-6d61-4829-a4a3-275b545776f8",
"db_currency_id": "d96b1a87-a8df-4a2b-b58a-305cfc9cb31b",
"db_language_id": "08105db9-d42b-482a-907a-8bbb2e17e833",
"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-07-24T03:57:04.9561629+00:00"
},
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "91ae7ee7-e38a-4e98-b17d-cd7209d77e28",
"date_reported_by_company": "2026-07-24T03:57:04.9561629+00:00",
"id2": 36,
"company_id": "92ee91e9-78fd-4417-b8ed-684859e1c235",
"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": "b0d8ad40-570a-42a8-a184-d526a549b68e",
"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-07-24T03:57:04.9561629+00:00"
},
"work_instruction_details_id": "63bd8cfb-036f-4a91-9b4b-03948ce71614",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "422e4a99-88c6-4b1c-9905-0d4c010aec36",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfce2570-8af6-4329-82be-706be58e7b03",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T03:57:04.9561629+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": "04cdd778-295e-49ea-ba9e-dc4eed0e8d38",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T03:57:04.9561629+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.