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": "7e8876d7-4b63-4a9a-b411-d781e8c2367e",
"jobs_id": "f93f4610-76a4-4740-9c99-1f6f626fad06",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "355a1c5a-61fd-412d-8c80-4eb99bb45e7b",
"_parent_id": "b0e494c4-e623-4ee2-93ef-2995ca45db02",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "13ff77f3-059f-4043-b80f-804023d5af19",
"project_reference_back_office": "sample string 5",
"project": {
"id": "931108db-28c7-4a48-bb75-5ad47531cc62",
"_parent_id": "858c3b8e-e7ea-4c6a-bd76-547934874425",
"root_parent_id": "9fd871e2-8471-4743-a866-a22d970049ad",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8bac35d4-876b-4f51-ae1b-99b6b80d519c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "55a9161a-91a4-49fd-aacc-65ec8e432bc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2616334e-1927-4520-a037-fbdfeee87fa5",
"_parent_code": "sample string 6",
"sales_organization_id": "5ad663c2-745c-4ae3-9d72-b31fd8b07e71",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00"
},
"equipment_model_id": "878a0b65-cd68-464c-8547-c9ef59126f3a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1d1dac9f-7ad7-41ab-b244-642ed04244fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c26934d3-0b62-4ca7-8f19-426d2eff72a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "daab758a-3b2e-4ca6-afde-41364f4d878a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ec9f66d2-ecb5-4011-9a38-da5edef5addd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00"
},
"equipment_family_id": "1e2cd9ee-3dcf-45cd-9136-db6716031ea8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "55a9161a-91a4-49fd-aacc-65ec8e432bc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2616334e-1927-4520-a037-fbdfeee87fa5",
"_parent_code": "sample string 6",
"sales_organization_id": "5ad663c2-745c-4ae3-9d72-b31fd8b07e71",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00"
},
"date_in_production_since": "2026-01-12T01:53:24.0466227+00:00",
"date_out_of_production_since": "2026-01-12T01:53:24.0466227+00:00",
"date_end_support": "2026-01-12T01:53:24.0466227+00:00",
"sales_organization_id": "abc4bce3-dd12-4e19-84f7-cbf931afe840",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+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-01-12T01:53:24.0466227+00:00"
},
"project_status_id": "84a34de6-0a1a-4833-9829-186e34ee1306",
"project_status_code": "sample string 10",
"project_status": {
"id": "10311f0a-22a0-46d4-b28e-c4154d396cfb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "17796311-c2b7-49b7-bcc5-1ba55ecf00ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00"
},
"company_id": "cb35d970-4222-4eda-905b-3eca7c0881ae",
"company_code": "sample string 12",
"db_address_id": "34a6c571-6cea-4084-8b77-2478c56cca61",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb713b6d-368f-443f-a188-b5ea166e87f3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3e96174e-e88e-46c1-84a0-cb46aeacfae6",
"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-01-12T01:53:24.0466227+00:00",
"date_create": "2026-01-12T01:53:24.0466227+00:00",
"date_update": "2026-01-12T01:53:24.0466227+00:00",
"updated_by_user_id": "68324dc1-93e4-472b-a445-da7e0828fa7b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-12T01:53:24.0466227+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-01-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-12T01:53:24.0466227+00:00",
"date_last_job": "2026-01-12T01:53:24.0466227+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-12T01:53:24.0466227+00:00",
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00",
"is_mobile_installation": true
},
"job_type_id": "50d6ae16-8df6-48ae-a90b-501a91cd990e",
"job_type_code": "sample string 7",
"job_type": {
"id": "ceda0db7-07e2-468e-b8a1-43f0ad36caab",
"name": "sample string 2",
"sales_organization_id": "abe7ee3c-558d-48a8-8e2b-fa71d379ceb0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b5682a8-ba4e-4f9b-ba87-b148cbdce8bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ab16179-4c93-42f1-a717-b61d4b6a85d4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "84efd273-dffa-4df1-a7c2-2e3b5bf54df3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T01:53:24.0466227+00:00"
},
"job_status_id": "8fecefc7-abf2-434e-ad16-11a35ba76b87",
"job_status_code": "sample string 11",
"db_address_id": "82bb8297-bf41-4cc7-bb68-ffe3096fb534",
"contact_id": "1ca0f66a-5907-471c-bf2a-e45936f8915b",
"requested_by_company_id": "27e115aa-c6c2-4663-9458-a398f6254c34",
"requested_by_contact_id": "4be1da73-f2f6-4b05-9d0d-8d943f0bfce6",
"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-01-12T01:53:24.0622416+00:00",
"due_date": "2026-01-12T01:53:24.0622416+00:00",
"date_create": "2026-01-12T01:53:24.0622416+00:00",
"date_update": "2026-01-12T01:53:24.0622416+00:00",
"date_closed": "2026-01-12T01:53:24.0622416+00:00",
"suggested_user_id": "4d943de1-622a-42f6-bfa7-95167f36a6a5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d397523-e61c-460d-900c-90af2290ae26",
"db_language_id": "d107c19a-d843-4293-ae5f-9ce654620d55",
"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-01-12T01:53:24.0622416+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "590eae12-c1f8-42c7-91bc-72f34f0829d5",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3996a52c-42bb-4abd-9551-38a57eab4f2b",
"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": "99f2cd9b-764a-4a06-ad70-dc4644de9336",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-12T01:53:24.0622416+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "92f6e492-0ad7-4708-b0e1-d32bbad4bec2"
},
"suggested_date_start": "2026-01-12T01:53:24.0622416+00:00",
"skill_id": "50d8d17d-101d-43b4-8146-bcf4766c3a97",
"skill_code": "sample string 32",
"skill": {
"id": "11e3bb44-7921-4cef-a0f8-dd277d742766",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e8999861-0311-4ef0-ba0d-6766419e92d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5babea30-3dae-4975-b993-b0c9df2e50b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba5917bf-73f2-46d0-89de-937e2843607e",
"db_currency_id": "30259574-a930-4ce5-9c0e-dc669344d2f4",
"db_language_id": "da5f8472-260d-4310-91d7-fd7f7c1c888a",
"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-01-12T01:53:24.0466227+00:00"
},
"modified_dateutc": "2026-01-12T01:53:24.0622416+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14ebdc34-e532-43a3-b076-337ccac9f644",
"date_reported_by_company": "2026-01-12T01:53:24.0622416+00:00",
"id2": 36,
"company_id": "f3a2b9de-cc71-46c7-ac5c-8d925b158e91",
"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": "20389ae1-757d-4b7e-a1ce-4ef59c17aee4",
"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-01-12T01:53:24.0622416+00:00"
},
"work_instruction_details_id": "6568e98e-f095-4f42-b2f1-5627001919b9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1c66ed40-ab75-4c0f-a3e7-a57b9748a927",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ffa48384-38d9-4b34-a39a-f25f81e6d940",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-12T01:53:24.0622416+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": "6d2a7711-07b9-4c97-8718-c47e42ff7a7f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-12T01:53:24.0622416+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.