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": "61bed647-d20b-450c-95eb-e063b82f5097",
"jobs_id": "9cc0aa7d-93ea-465e-b175-51b722d8ceb3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "59bd60ca-16d4-4caf-adaa-13ea295c1ed0",
"_parent_id": "0037a606-b847-4147-9943-0a65f5cb0247",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5ab1f4d5-a2ad-46ae-8f76-13a5aa5fc890",
"project_reference_back_office": "sample string 5",
"project": {
"id": "85577e8e-a12c-4052-b9b0-f71e6aef0226",
"_parent_id": "f915b9d8-5c68-43f5-b8c9-fcbc87960843",
"root_parent_id": "56a7d0e5-0cf8-4c72-9004-3bc0603db0e1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "692279f3-e87c-4047-91be-23c4a0214c6e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7bee4753-eaf6-4a41-bdf7-66adce6ea9b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "490d6e37-fc76-4693-8312-dc038d1f9a5f",
"_parent_code": "sample string 6",
"sales_organization_id": "9b909a0c-ecdc-41c0-a99e-f553d0049e54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"modified_dateutc": "2026-10-11T15:39:37.0316754+00:00"
},
"equipment_model_id": "c44f0afc-ef9a-456d-919e-b8caecc03fe2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a1366a23-46bd-4ec3-870c-e96583b8f68b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6c50efef-37df-448f-b87b-198bc0dc1647",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fad674d4-e989-4a22-a833-26cf55c6c3d1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4161c3c2-6990-43bf-98bf-cbed1515ce4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"modified_dateutc": "2026-10-11T15:39:37.0316754+00:00"
},
"equipment_family_id": "e41fa4be-24c8-459e-a9db-3f19adcd65ef",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7bee4753-eaf6-4a41-bdf7-66adce6ea9b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "490d6e37-fc76-4693-8312-dc038d1f9a5f",
"_parent_code": "sample string 6",
"sales_organization_id": "9b909a0c-ecdc-41c0-a99e-f553d0049e54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"modified_dateutc": "2026-10-11T15:39:37.0316754+00:00"
},
"date_in_production_since": "2026-10-11T15:39:37.0316754+00:00",
"date_out_of_production_since": "2026-10-11T15:39:37.0450723+00:00",
"date_end_support": "2026-10-11T15:39:37.0450723+00:00",
"sales_organization_id": "a7230c6b-bbaf-46e0-b53f-064f8859b36b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+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-10-11T15:39:37.0450723+00:00"
},
"project_status_id": "1f927a70-cc8b-48ff-a98a-c4f27e685cec",
"project_status_code": "sample string 10",
"project_status": {
"id": "69d7a2ea-72a6-41ab-bdd8-74a9dee0c0d7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0d33a75-2555-463c-b047-79ee2bb73a1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00"
},
"company_id": "da0dff05-920e-4a1c-9e40-0a911d4c3abc",
"company_code": "sample string 12",
"db_address_id": "a52cd23b-e6e0-479c-9242-5ab4cd6aa35b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1a6f2fd8-127d-441b-a45e-f7f835dc51c9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "769f75b5-a447-455b-8ab8-698c53f9323c",
"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-10-11T15:39:37.0450723+00:00",
"date_create": "2026-10-11T15:39:37.0450723+00:00",
"date_update": "2026-10-11T15:39:37.0450723+00:00",
"updated_by_user_id": "358c0f33-4e64-4690-a9fd-b6bf1384e850",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-11T15:39:37.0450723+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-10-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-11T15:39:37.0450723+00:00",
"date_last_job": "2026-10-11T15:39:37.0450723+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-11T15:39:37.0450723+00:00",
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00",
"is_mobile_installation": true
},
"job_type_id": "5d24dbef-b45b-447a-9527-c01a4ac06ac3",
"job_type_code": "sample string 7",
"job_type": {
"id": "a14f2279-85cb-48b3-9c7c-71a7ea08d8ce",
"name": "sample string 2",
"sales_organization_id": "926d99ed-074d-4be5-b298-6f19dcaaab90",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00",
"code": "sample string 7"
},
"job_priority_id": "544c5f97-ccf4-4869-9814-5025b45ce56a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c4371676-a2f1-425c-8bc7-f81156dac051",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "835e18e8-eb9b-4a42-bc9f-a645305510e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00"
},
"job_status_id": "3cbdf955-2dd7-4bf1-a978-6114807d8c06",
"job_status_code": "sample string 11",
"db_address_id": "6e08537d-0a17-4db9-af35-0775f618758b",
"contact_id": "432560f1-59dc-4f1b-b314-a261605ccfec",
"requested_by_company_id": "8ff6672e-62d2-495d-957a-b23c5a7cfa56",
"requested_by_contact_id": "439803f1-cf4d-49a5-a4f8-96ba4ae44bdd",
"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-10-11T15:39:37.0450723+00:00",
"due_date": "2026-10-11T15:39:37.0450723+00:00",
"date_create": "2026-10-11T15:39:37.0450723+00:00",
"date_update": "2026-10-11T15:39:37.0450723+00:00",
"date_closed": "2026-10-11T15:39:37.0450723+00:00",
"suggested_user_id": "d2a5755b-eac8-45f8-8fb3-49097805d42d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c0b8b198-5083-465c-8a13-9da87c511671",
"db_language_id": "70e9dc12-59fb-4f0c-b16a-61cdc464b5ef",
"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-10-11T15:39:37.0450723+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7be48206-71bc-4183-b7ad-2c25974b51ea",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51a39e97-39b3-4967-9be3-8e113dbae43a",
"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": "3a863377-1512-40f9-a569-ea7708b9f19c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9831062a-cb3e-4a40-8558-c17c572c1f90"
},
"suggested_date_start": "2026-10-11T15:39:37.0450723+00:00",
"skill_id": "dddcddba-3c1c-47d2-8d65-66cc4a75ab46",
"skill_code": "sample string 32",
"skill": {
"id": "f3f4a855-9065-490a-82ff-a3942f4c276e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7ed1e55d-ccd8-448a-840a-5a2bbbc24e27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e47cf1c-3b90-4a97-a677-2a27f90cda7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08909c50-8ec5-464d-921e-277dc8fddf5f",
"db_currency_id": "e7c23419-4fb5-4c41-a452-7cdd06081f83",
"db_language_id": "853c1825-6daf-4048-bcb3-975f41eb9280",
"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-10-11T15:39:37.0316754+00:00"
},
"modified_dateutc": "2026-10-11T15:39:37.0450723+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "51f60534-e765-40f7-9b59-7fcf7d64dd6e",
"date_reported_by_company": "2026-10-11T15:39:37.0450723+00:00",
"id2": 36,
"company_id": "e2b2e361-f7e6-4385-a58d-fdb8746a0f65",
"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": "46c848ca-b5d1-4c95-a707-f2a75dca09f9",
"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-10-11T15:39:37.0450723+00:00"
},
"work_instruction_details_id": "2250ec85-d8b9-468e-8c5d-ae8a0b0411a6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6367ba58-a419-44aa-a680-e24422115948",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02d02acc-4332-4984-894d-55c1ffe9e293",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-11T15:39:37.0617255+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": "f2792596-5a66-4241-a603-a1d79b644efd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-11T15:39:37.0617255+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.