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": "434c3120-5947-46f7-8faa-aecb32cbfa3e",
"jobs_id": "9b94902a-f782-4fb8-bf21-6702e785fce0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5efa885b-a722-4776-9ce7-c0699a5350a3",
"_parent_id": "469b9223-3dfd-4e1f-9cfa-2d567441d2bc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "476a0af8-0b5a-4974-8361-4cea609ba3f7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "765b48a7-75f0-4f5d-a390-c5ae6446469b",
"_parent_id": "5091d4fb-fc5b-45f2-8787-67b4d86b7761",
"root_parent_id": "21fdb691-8295-440c-aea7-a3606f080cfc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4d9ccccf-40a1-40d6-9e28-17c9991c2ad1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5e491c5a-1dab-47be-b00d-746cb2d30f28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59876a55-3062-42d3-a0a8-860303e585ba",
"_parent_code": "sample string 6",
"sales_organization_id": "ff0adb90-ddb0-4353-9de1-ed3904e04137",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"equipment_model_id": "c4783ac4-e4d7-4fcb-bbc9-3a32153d90f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "71670eda-c02e-4b23-8f1e-83e36fb1a2a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e15adfdf-d2e5-4d88-a738-c16737743104",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d94ddb7e-4e93-4a49-8f85-ca917ed9db42",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9f1e0b66-cc3c-4c51-96c5-0ad6dfd1f40d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"equipment_family_id": "c4e64167-f07c-4fd4-a81d-567db6d36ff5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5e491c5a-1dab-47be-b00d-746cb2d30f28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59876a55-3062-42d3-a0a8-860303e585ba",
"_parent_code": "sample string 6",
"sales_organization_id": "ff0adb90-ddb0-4353-9de1-ed3904e04137",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"date_in_production_since": "2026-09-26T07:55:42.9260384+00:00",
"date_out_of_production_since": "2026-09-26T07:55:42.9260384+00:00",
"date_end_support": "2026-09-26T07:55:42.9260384+00:00",
"sales_organization_id": "9dff3d75-5a9e-4c18-8030-06a9d3d25d78",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+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-09-26T07:55:42.9260384+00:00"
},
"project_status_id": "cfdf67a7-7d30-4071-ae68-a8959e1fecd7",
"project_status_code": "sample string 10",
"project_status": {
"id": "8ff13afa-a95f-4662-88f8-4442efb6b35d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b6b5fec3-6260-4ac0-aaea-ddacbd5b3dca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"company_id": "1a39edf4-f81a-4e34-b9bd-fdd24928d3f0",
"company_code": "sample string 12",
"db_address_id": "ca315bb1-8f8d-4250-a6cd-96291c296ba7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a114bf2-e4a5-4e18-8013-04f0902190d2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "52f0dab7-4058-4e97-94c0-3ca8ce61a9c9",
"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-09-26T07:55:42.9260384+00:00",
"date_create": "2026-09-26T07:55:42.9260384+00:00",
"date_update": "2026-09-26T07:55:42.9260384+00:00",
"updated_by_user_id": "1ff2b866-db65-406b-a65d-198ae7106f07",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-26T07:55:42.9260384+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-09-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-26T07:55:42.9260384+00:00",
"date_last_job": "2026-09-26T07:55:42.9260384+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-26T07:55:42.9260384+00:00",
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00",
"is_mobile_installation": true
},
"job_type_id": "d53458d6-9741-4dcd-b8a1-59ed075450db",
"job_type_code": "sample string 7",
"job_type": {
"id": "79a86bfd-3699-4a62-bab7-d0a03a05ed1f",
"name": "sample string 2",
"sales_organization_id": "da040e1b-04d1-427a-a53b-3c3bdc9e3048",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00",
"code": "sample string 7"
},
"job_priority_id": "6f9d7107-b2e1-48a6-982a-74a5c32bbd65",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2d2a741b-08b9-4c78-a6ad-380d07d71efd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c9b06c7b-9bcb-4474-865c-b6d6118226e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"job_status_id": "fa8b6a13-acd7-45fd-95db-c1567983948d",
"job_status_code": "sample string 11",
"db_address_id": "7ef178bd-f1de-4c61-b160-6970b751f11c",
"contact_id": "df4af853-3b6d-48ef-a9b9-cce99e7492ea",
"requested_by_company_id": "0e1f1136-33ed-4634-94f4-ec8b567452d6",
"requested_by_contact_id": "00b88d32-99e2-43ce-9169-62caea898a36",
"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-09-26T07:55:42.9260384+00:00",
"due_date": "2026-09-26T07:55:42.9260384+00:00",
"date_create": "2026-09-26T07:55:42.9260384+00:00",
"date_update": "2026-09-26T07:55:42.9260384+00:00",
"date_closed": "2026-09-26T07:55:42.9260384+00:00",
"suggested_user_id": "86ee9727-d057-4322-b896-3861ad3a4faf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d99665df-26fc-4a2c-818e-012e48a9cc58",
"db_language_id": "e5e63f0a-163b-4fd9-a92c-1821e66ae2ed",
"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-09-26T07:55:42.9260384+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0513c053-fc46-4d98-87d1-92815dd3b14f",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c1d5fa74-005f-4c23-a48b-4df59f12fc8f",
"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": "4a14c0bb-5584-4a27-b31c-eefa34551f32",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6c6bb77a-c62f-47df-9297-4c0f505f8231"
},
"suggested_date_start": "2026-09-26T07:55:42.9260384+00:00",
"skill_id": "7e33c5a9-640a-482d-b603-740c79d95416",
"skill_code": "sample string 32",
"skill": {
"id": "93317585-9a2b-4a1d-bee7-a617910efe0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "51996d73-9a95-40d7-a460-51a7687c001d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c929295-7dbb-491e-9bc3-0d597cad5c87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b4c82f-67b6-4eaa-aa13-cdb4728a9b82",
"db_currency_id": "efad2a32-b1ac-48ce-b461-47ec5e985c8d",
"db_language_id": "56003771-5acf-4ec5-9ed8-567dd49e8cb4",
"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-09-26T07:55:42.9260384+00:00"
},
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "40a8bde1-97f1-4407-a2e8-cfff5ea91ade",
"date_reported_by_company": "2026-09-26T07:55:42.9260384+00:00",
"id2": 36,
"company_id": "ca665c19-8072-49f0-ac31-ab52f9c4fe06",
"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": "58d6480c-c207-413e-85ff-ea951fa0edf1",
"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-09-26T07:55:42.9260384+00:00"
},
"work_instruction_details_id": "e6fb6bee-5582-4316-aeba-bbe85c3705d9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "868b6ccf-8aea-4c93-b043-25841a30b7c7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ca341f9-a095-46c0-8ff9-3669fa8e0e4e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-26T07:55:42.9260384+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": "d6d8a048-fe97-440e-a5e7-950ad5ce7882",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-26T07:55:42.9260384+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.