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": "279b608b-bced-49cd-9776-4b26989cf59e",
"jobs_id": "16132dd5-2374-4c18-8fde-db86afedcee1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a20b25a6-f847-422d-b4b2-1abd69db260c",
"_parent_id": "09e78096-58fa-48c1-bd8a-a23d2f05fed7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5432bc7d-1e1b-4d1e-af8b-6faad8bf31d5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9aee33c2-a1e7-4d3f-9726-64b429061529",
"_parent_id": "5df9b05d-1e26-4cf6-8221-03616ee94239",
"root_parent_id": "df326274-baba-4776-b98b-a9683bdd9a0b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8017d0d0-6050-4a9a-b53b-6e8e6051860f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0570df5d-197b-43e7-b8f5-3a14a1ccd8af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da6d3e98-ed87-4b2d-a1bf-d16302232f9d",
"_parent_code": "sample string 6",
"sales_organization_id": "4fc49c16-90fb-4995-862d-a6f356e6e69d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"equipment_model_id": "7fd2dfec-b6fd-4ae0-ab64-5c658d4e632f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "070969e4-0ee7-49cc-9923-c160747d3815",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0640c21e-6f6d-47c2-bdce-868330399f56",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9364591a-d63f-4495-9151-57b7c873c2cd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b4a49f5f-c25b-4964-9929-2e1805e3ee09",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"equipment_family_id": "69a94dbc-77cb-4528-8ee6-83621f3dd96c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0570df5d-197b-43e7-b8f5-3a14a1ccd8af",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da6d3e98-ed87-4b2d-a1bf-d16302232f9d",
"_parent_code": "sample string 6",
"sales_organization_id": "4fc49c16-90fb-4995-862d-a6f356e6e69d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"date_in_production_since": "2026-05-23T07:06:56.6973054+00:00",
"date_out_of_production_since": "2026-05-23T07:06:56.6973054+00:00",
"date_end_support": "2026-05-23T07:06:56.6973054+00:00",
"sales_organization_id": "d03c0b77-5e59-42d8-80a1-92b7ced824fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+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-05-23T07:06:56.6973054+00:00"
},
"project_status_id": "5f2695ca-07e3-4db8-812c-ba6bed88b720",
"project_status_code": "sample string 10",
"project_status": {
"id": "f0a1beae-529e-42a4-b769-f18e3423215a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b4b5f34-0055-45e1-822c-a7d48a747d52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"company_id": "f82f325f-b772-4232-84ac-605fa4084879",
"company_code": "sample string 12",
"db_address_id": "a32a6bb1-3ab2-4225-92d3-65d1edd93722",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f304ddee-64fa-4902-95c5-472615bc689c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cc862350-ff92-47f0-a80a-7897d7d5e97b",
"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-05-23T07:06:56.6973054+00:00",
"date_create": "2026-05-23T07:06:56.6973054+00:00",
"date_update": "2026-05-23T07:06:56.6973054+00:00",
"updated_by_user_id": "3f39b550-aae5-43dd-9a4e-12ee02d2778e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T07:06:56.6973054+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T07:06:56.6973054+00:00",
"date_last_job": "2026-05-23T07:06:56.6973054+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T07:06:56.6973054+00:00",
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00",
"is_mobile_installation": true
},
"job_type_id": "d33a988e-74a6-4fb8-80fb-32d221e89b04",
"job_type_code": "sample string 7",
"job_type": {
"id": "fe21c463-d7e7-48df-94b6-5387d0dd4606",
"name": "sample string 2",
"sales_organization_id": "cd651cf6-1800-4758-b28a-0b3e689add47",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00",
"code": "sample string 7"
},
"job_priority_id": "1acbaeb5-e3e5-4f49-9f49-0e9777545fa8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9e4dae16-cea5-43dc-aace-60b08f961941",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e82b642c-d2ef-447c-956f-cf2848d687f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"job_status_id": "d6720829-d2d5-4ee9-88a5-a45d97ca6c63",
"job_status_code": "sample string 11",
"db_address_id": "775c39c5-0b8d-43cd-b542-22c339b9e53e",
"contact_id": "effcff32-aea6-4a69-80ae-c0cebe629365",
"requested_by_company_id": "11831880-80ef-4def-b96b-f01886e7aa48",
"requested_by_contact_id": "6c6a54d8-5ff4-4d99-987d-7df24229e9b3",
"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-05-23T07:06:56.6973054+00:00",
"due_date": "2026-05-23T07:06:56.6973054+00:00",
"date_create": "2026-05-23T07:06:56.6973054+00:00",
"date_update": "2026-05-23T07:06:56.6973054+00:00",
"date_closed": "2026-05-23T07:06:56.6973054+00:00",
"suggested_user_id": "f2bb04b7-708e-4fc1-b7d6-0efb5ee10e28",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8b17caa2-dd7f-4e53-b6b1-77d4d68ff5fb",
"db_language_id": "8239c44b-1ea4-417a-9fb5-6292824b62df",
"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-05-23T07:06:56.6973054+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e0db87b3-0393-44a6-a4b1-c638d0984efc",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "58c6c737-0006-46c2-aa0c-0edc515e5ddc",
"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": "ad2b136d-3fc6-408c-8064-a59858190d50",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2417363b-6481-4fd5-8b15-af43b653389c"
},
"suggested_date_start": "2026-05-23T07:06:56.6973054+00:00",
"skill_id": "367b296e-8f39-4b41-abe6-09fa757ca221",
"skill_code": "sample string 32",
"skill": {
"id": "99ddc4b4-28e5-4151-8c37-5649bbd5f229",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "659fccde-9c86-4877-8f3f-5a6c42ce8118",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8467b8ea-85bd-4710-bf7b-5282a2d94fa7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f231956e-7f53-4560-baba-f2ea3c798cc2",
"db_currency_id": "9b29ac15-9097-4f66-9050-3cf69505088b",
"db_language_id": "02381a0e-dca9-423a-859a-858d9659beac",
"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-05-23T07:06:56.6973054+00:00"
},
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a04dbbf1-7c77-47ba-ab29-4dec21f45af4",
"date_reported_by_company": "2026-05-23T07:06:56.6973054+00:00",
"id2": 36,
"company_id": "492dc0be-1c0b-49a9-b2d2-fa924b916ce7",
"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": "07eb0122-71d8-42f8-b47e-5f519a8e3cb4",
"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-05-23T07:06:56.6973054+00:00"
},
"work_instruction_details_id": "38779dff-867a-4d77-94fd-fd27f5f1422d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8e49a60d-4e9b-4cb5-8f8c-632a4e59f736",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7218f3e9-d520-43d3-86d4-c84a3f305bef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T07:06:56.6973054+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": "941e6f73-a632-49d1-9cbe-ffdf8866e7d3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T07:06:56.6973054+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.