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": "4c423e3f-9053-460f-9d4d-c2d4cfebe9fa",
"jobs_id": "043e76e0-2de5-493d-b3ae-5a6b2017cf2e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fa3c9f79-9cf6-44e3-a770-a3f87e24ec98",
"_parent_id": "fe0fbd74-3b05-4b2c-a02e-b62d47903556",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8bc1b9c5-7b9a-48d7-b78c-29b21b001aca",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3391c035-2b6b-4d20-88ea-3d4e8b27f7d5",
"_parent_id": "de31c8d1-e2f1-4ee6-97f1-b52eb11c16ae",
"root_parent_id": "2cf96aeb-1ccd-4dbe-8000-7a2c9e151887",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "45f0064a-d27c-4ab1-91aa-b4b825c13ce1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "647d593b-759d-44c7-8534-04541e35075f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b270a6a5-876d-4bd3-a782-7b04ece15836",
"_parent_code": "sample string 6",
"sales_organization_id": "26c037e6-4278-4fbe-bc1b-20ba44441b5f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"equipment_model_id": "87b83889-1552-4806-93f8-cd21b7d3256d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "69aac064-c37d-4edb-baf3-ff85204cc4ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f61e83e-b92b-4cb3-b07f-9863ed0b7313",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cac64966-87ca-4395-9ab6-60d156aec273",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "40bb7b15-c682-44e0-927a-acedda875bb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"equipment_family_id": "f3f89bd5-8814-4c20-8c66-c5b0413d6c16",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "647d593b-759d-44c7-8534-04541e35075f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b270a6a5-876d-4bd3-a782-7b04ece15836",
"_parent_code": "sample string 6",
"sales_organization_id": "26c037e6-4278-4fbe-bc1b-20ba44441b5f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"date_in_production_since": "2026-02-19T11:48:39.3473191+00:00",
"date_out_of_production_since": "2026-02-19T11:48:39.3473191+00:00",
"date_end_support": "2026-02-19T11:48:39.3473191+00:00",
"sales_organization_id": "808ff665-1d55-417c-b32f-916028058628",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+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-02-19T11:48:39.3473191+00:00"
},
"project_status_id": "b0aa5420-0c2a-4275-a93c-6cbc77c923bd",
"project_status_code": "sample string 10",
"project_status": {
"id": "eede7a61-59d3-4448-8d05-ea2f5d690526",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "340e578f-edb4-475a-a5fc-5faeb3d5bd5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"company_id": "e88b408c-fd19-4a38-9be1-c9cf02c0e2b9",
"company_code": "sample string 12",
"db_address_id": "d5ea2ae2-0770-40c6-807a-e034641c6884",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "25c1ed39-3c36-41ec-bb4a-062951d5b115",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9ea804ef-558e-47b0-ab38-9a56760bc5d3",
"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-02-19T11:48:39.3473191+00:00",
"date_create": "2026-02-19T11:48:39.3473191+00:00",
"date_update": "2026-02-19T11:48:39.3473191+00:00",
"updated_by_user_id": "ead2d80e-e2d3-4cd0-8c44-208e426fd2db",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-19T11:48:39.3473191+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-02-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-19T11:48:39.3473191+00:00",
"date_last_job": "2026-02-19T11:48:39.3473191+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-19T11:48:39.3473191+00:00",
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00",
"is_mobile_installation": true
},
"job_type_id": "fcb8e3a5-5d9d-46c2-8881-ead3b929ed0c",
"job_type_code": "sample string 7",
"job_type": {
"id": "48477de1-6b2a-4168-bc56-d9b68ac63d1a",
"name": "sample string 2",
"sales_organization_id": "01989976-3906-4768-84cf-10b4f507c6f2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00",
"code": "sample string 7"
},
"job_priority_id": "b076fc87-2ba0-49a8-97c3-98807e877b55",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cafc77cf-4329-4077-9522-48fb7e029182",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a7f795c7-7c9b-4159-b07e-abf44cfabcf6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"job_status_id": "e8b11d15-3a8d-4aec-acd4-f351f87427a6",
"job_status_code": "sample string 11",
"db_address_id": "9950d85b-32d9-4faa-bed3-458d4435353a",
"contact_id": "1299dc53-96d5-49ba-a442-e9b818944973",
"requested_by_company_id": "77c5b56b-256f-4fd8-a015-0f929cfc792f",
"requested_by_contact_id": "f7dd74a0-1632-4b30-9acb-8b0495bff6c9",
"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-02-19T11:48:39.3473191+00:00",
"due_date": "2026-02-19T11:48:39.3473191+00:00",
"date_create": "2026-02-19T11:48:39.3473191+00:00",
"date_update": "2026-02-19T11:48:39.3473191+00:00",
"date_closed": "2026-02-19T11:48:39.3473191+00:00",
"suggested_user_id": "66f12a66-5e33-46d1-a3ab-7921e1338a8b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e1724f24-888c-4dc4-98ed-4f0a318d41ba",
"db_language_id": "6fb3a664-5364-4a17-84a5-3e304e0a71b6",
"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-02-19T11:48:39.3473191+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c525668-2bb4-4d3d-9f24-bdd6d57cc6ce",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cd58a882-4326-441b-b425-2a030d153e28",
"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": "75a07def-d17b-4dbd-843a-26efbff996c9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "633f196e-79e7-4425-b85d-3acf818686ff"
},
"suggested_date_start": "2026-02-19T11:48:39.3473191+00:00",
"skill_id": "14abf3cd-f017-4eee-ba82-8d645131cebf",
"skill_code": "sample string 32",
"skill": {
"id": "c4d98e48-be6a-4c78-91c8-c4472272cc17",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eb6ce607-0db4-420c-b196-3666ef80f3d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86b0ca98-e9c3-4b28-8167-a2798c013763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a8e50b6-f6db-4b00-ae27-4906420f5079",
"db_currency_id": "339ae37a-a043-4a96-b94f-bf524b21507e",
"db_language_id": "ea2915ea-9ffe-423a-ba40-b0340caebbdb",
"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-02-19T11:48:39.3317002+00:00"
},
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b054e164-c0f8-4623-8141-9cbf06440e49",
"date_reported_by_company": "2026-02-19T11:48:39.3473191+00:00",
"id2": 36,
"company_id": "5adcc5a5-215a-4614-a216-8f900c7318bb",
"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": "3b02555c-2e46-45b6-a733-a25074317d30",
"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-02-19T11:48:39.3473191+00:00"
},
"work_instruction_details_id": "5d806794-5ed2-49e9-a4b0-f19004cae63f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fee3b2a4-c473-4456-86c6-2dbb19e5f3f8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "13b76de8-afd1-4129-942b-979fd30572e1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-19T11:48:39.3473191+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": "ceeb253d-0dc3-4dff-bb31-872a4a2e0b1d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-19T11:48:39.3473191+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.