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": "39b374fb-890e-494f-b9ca-74860de23696",
"jobs_id": "0bbc9ca8-78a1-4f28-a574-44a84cf6500c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94c915b2-048f-4db0-829b-146e2d9d89c7",
"_parent_id": "39537f4e-bba6-47d8-afe0-3c7c4953bea6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "52223416-27c9-40d5-9476-857904af92a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e041717d-d261-4aee-8582-f41189a23c25",
"_parent_id": "159b03cd-4394-497a-80b1-bc3f595f74b0",
"root_parent_id": "449df1a7-13cd-460f-9a3f-8219df0b33ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8e4f6318-d0af-4e8f-a636-9551aa874b03",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f01c7d13-363e-43ed-8626-72e2db13e0b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8e8d233a-e8f8-4661-b947-a9d32f0ef41a",
"_parent_code": "sample string 6",
"sales_organization_id": "a482647c-50a8-4ea7-b903-57898f9dc9fb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"equipment_model_id": "3e484fc7-b330-4978-8844-c1bb4765b1ee",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "05250291-c7f9-4475-ba15-9803680e68be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bba71df1-30ec-46fa-a5c6-835d8df69cf7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "482a21c5-a0b8-4060-bfbf-53c786b8820b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c925deaa-af0a-4667-86f1-7c8f941533a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"equipment_family_id": "e7c14f8e-d642-4134-adad-a6f43258c83b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f01c7d13-363e-43ed-8626-72e2db13e0b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8e8d233a-e8f8-4661-b947-a9d32f0ef41a",
"_parent_code": "sample string 6",
"sales_organization_id": "a482647c-50a8-4ea7-b903-57898f9dc9fb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"date_in_production_since": "2026-06-17T17:34:14.6670126+00:00",
"date_out_of_production_since": "2026-06-17T17:34:14.6670126+00:00",
"date_end_support": "2026-06-17T17:34:14.6670126+00:00",
"sales_organization_id": "24d41050-5b02-4d7e-be9e-3bf29cfc61a4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+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-06-17T17:34:14.6670126+00:00"
},
"project_status_id": "1bb0c076-41e1-4c4e-aee6-536570426c52",
"project_status_code": "sample string 10",
"project_status": {
"id": "f2ddd042-5a32-4834-9cb2-c824f532d68e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "30e7e87b-1dcd-4853-897b-3375d2119110",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"company_id": "0bace191-4b95-4d19-89a7-256d8daa02a8",
"company_code": "sample string 12",
"db_address_id": "f7b7ea0b-edd3-4f25-873d-dda358248a1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6334e08c-2310-48b1-99c3-6563a230d967",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f2ab7293-3325-4748-9c54-e7d9e8659c65",
"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-06-17T17:34:14.6670126+00:00",
"date_create": "2026-06-17T17:34:14.6670126+00:00",
"date_update": "2026-06-17T17:34:14.6670126+00:00",
"updated_by_user_id": "3fadb6e1-231a-463e-907b-5b813dd3dd78",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-17T17:34:14.6670126+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-06-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-17T17:34:14.6670126+00:00",
"date_last_job": "2026-06-17T17:34:14.6670126+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-17T17:34:14.6670126+00:00",
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00",
"is_mobile_installation": true
},
"job_type_id": "db828d6d-5003-492b-91cc-d5a0d932f5f6",
"job_type_code": "sample string 7",
"job_type": {
"id": "78a45baf-ed8e-449c-8191-d58982062352",
"name": "sample string 2",
"sales_organization_id": "8d8690b6-7e34-4acb-9340-a50e092b296d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00",
"code": "sample string 7"
},
"job_priority_id": "75a4ea5b-ca81-433b-a9b3-d24f995d8b64",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e9ada9fc-6640-47c3-8ff9-f6ee7a76259a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3d49ff42-9bbe-4ee0-b7bf-6cc8baa8840e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"job_status_id": "94a68213-398d-4f88-b641-b703c68e45c0",
"job_status_code": "sample string 11",
"db_address_id": "68669b1c-88e2-4b66-8dda-e5b896f14518",
"contact_id": "f7fd38b0-4a1d-4959-bbd4-06c24d8b477b",
"requested_by_company_id": "9b0e1cb5-7d82-40c5-aad2-fe86a863c947",
"requested_by_contact_id": "8e5ff54b-fc8a-451d-abfe-aa5ee0c694a1",
"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-06-17T17:34:14.6670126+00:00",
"due_date": "2026-06-17T17:34:14.6670126+00:00",
"date_create": "2026-06-17T17:34:14.6670126+00:00",
"date_update": "2026-06-17T17:34:14.6670126+00:00",
"date_closed": "2026-06-17T17:34:14.6670126+00:00",
"suggested_user_id": "a9dc34c2-3474-40b8-8853-54e2ace0a56d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "957bfe36-8716-459d-a067-32ab13463ce7",
"db_language_id": "3d94b460-fa0a-489d-8291-d86ae35a04f7",
"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-06-17T17:34:14.6670126+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b64cf467-a776-4f91-bace-789d177c61c9",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b9e94db2-8244-40a8-9fc4-a7fa8b012240",
"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": "47f809b0-f5fb-4891-b456-e3b2fb20076c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d6805009-427a-41dc-ac3e-33b6b21db19b"
},
"suggested_date_start": "2026-06-17T17:34:14.6670126+00:00",
"skill_id": "bdeee731-7322-4c39-86bf-33639a63394f",
"skill_code": "sample string 32",
"skill": {
"id": "4b81ee71-f34a-461e-ab02-46b0f49ec1bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a5d4913-30e8-4ed8-a9fb-5ac47293cd02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc0cba04-27cb-4e84-86a6-49c5773d3677",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41005fc7-37f0-42ab-a5df-2c9c1a6b0a60",
"db_currency_id": "5b397e93-89ca-4230-af9f-e78ee5261573",
"db_language_id": "bdb3bedb-7614-4d91-abc5-f1c77ed04da1",
"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-06-17T17:34:14.6670126+00:00"
},
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ebb4fd93-c729-49e3-a058-16a804d5f16e",
"date_reported_by_company": "2026-06-17T17:34:14.6670126+00:00",
"id2": 36,
"company_id": "b9a32112-5a11-4f55-bbf6-dd14a111abb9",
"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": "96982e17-363a-475b-b31c-885a72fd16d4",
"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-06-17T17:34:14.6670126+00:00"
},
"work_instruction_details_id": "260f689a-fc71-4c2c-ad58-4fd8f05d2260",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ca31be01-7de9-4e63-946c-1a679cb36d99",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c826ed91-b9be-4130-9dc7-ad624d5a2b78",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-17T17:34:14.6670126+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": "d19feafc-ba9b-4704-aec9-a588c5bf3921",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-17T17:34:14.6670126+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.