Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "2fe1aaa5-82c2-4d03-962f-cd6c4e34d3b8",
"jobs_id": "74cbb1a3-84a6-47ab-bbe8-9306f3d400b9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "56bffcd3-036c-4168-bc12-ea93278244c4",
"_parent_id": "eba25358-ecfa-48b5-a8ec-fd0ee868f3b4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4538cd5c-2cac-4cc0-96cc-186893cf9010",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26d0c9c1-13ae-4065-9204-4cf66a66b6c5",
"_parent_id": "f02a0dd5-d9c5-42ac-b2fb-cc7904023ca1",
"root_parent_id": "61a274ec-e659-4a68-914c-fa99f4b6725e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "09c28de4-95b5-401f-a3bb-3ae1c09b5e94",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "191d962f-93d0-47bb-a1db-da18d73d3b40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "acaca8d2-4583-4044-8d95-c5b2a2ad76b9",
"_parent_code": "sample string 6",
"sales_organization_id": "588afb6f-3791-4631-94c9-d20336fc636f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"equipment_model_id": "2e98eb60-126a-41c4-a7a2-2def7256bce5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0feab2ce-4320-4b9c-b5d9-9633ac705403",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "86e5f24d-839f-4456-8402-795345445131",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "67b250a2-6481-4a16-bdee-d8fcbdb875d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e2809746-c306-48e4-9615-108aa2637745",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"equipment_family_id": "50d31322-0aed-49df-ac12-5f8971747957",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "191d962f-93d0-47bb-a1db-da18d73d3b40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "acaca8d2-4583-4044-8d95-c5b2a2ad76b9",
"_parent_code": "sample string 6",
"sales_organization_id": "588afb6f-3791-4631-94c9-d20336fc636f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"date_in_production_since": "2026-05-07T20:56:01.6559728+00:00",
"date_out_of_production_since": "2026-05-07T20:56:01.6559728+00:00",
"date_end_support": "2026-05-07T20:56:01.6559728+00:00",
"sales_organization_id": "b52da5ec-2194-4a63-92aa-ccfe1f25b072",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+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-07T20:56:01.6559728+00:00"
},
"project_status_id": "fed8e502-8f19-4193-80ed-d503e6154596",
"project_status_code": "sample string 10",
"project_status": {
"id": "0181ee25-c6fb-4938-a15c-b4b147f541ae",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b2d87da6-3b31-457e-acc6-8cabd79132ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"company_id": "3543b5b7-4f80-441c-bd72-f0fddcd24817",
"company_code": "sample string 12",
"db_address_id": "b0a972ee-0c59-4fa6-b0d9-98984a23fb2c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e302c496-bcea-49aa-b0c8-7cae5439f1ea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "53862494-2e18-4dc9-8b12-834b28e49d2c",
"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-07T20:56:01.6559728+00:00",
"date_create": "2026-05-07T20:56:01.6559728+00:00",
"date_update": "2026-05-07T20:56:01.6559728+00:00",
"updated_by_user_id": "26435b0e-6707-4c5a-934d-cb19994fd472",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T20:56:01.6559728+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T20:56:01.6559728+00:00",
"date_last_job": "2026-05-07T20:56:01.6559728+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T20:56:01.6559728+00:00",
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00",
"is_mobile_installation": true
},
"job_type_id": "a64a509f-6ee9-4f8a-8a1e-4f8c10629b81",
"job_type_code": "sample string 7",
"job_type": {
"id": "57c21553-c9a9-43dc-911c-ba571eb41fed",
"name": "sample string 2",
"sales_organization_id": "9d82d676-03f5-4390-b87c-164f784ade54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00",
"code": "sample string 7"
},
"job_priority_id": "857c6f79-efd2-476b-8346-b4cdedd0ff99",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "19a19216-a7ae-4d91-b9e6-8ebdc87471f0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bff14b9c-798f-425d-a2f8-511a737e8e65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"job_status_id": "a842d21c-ad73-4c53-a119-26082f54fa10",
"job_status_code": "sample string 11",
"db_address_id": "77e6f75d-8351-45b9-8c13-7e9efce10611",
"contact_id": "485235cb-a514-4263-a7f6-911e384a3450",
"requested_by_company_id": "2d998740-14a4-4161-8d13-64c15d724b54",
"requested_by_contact_id": "c481392c-5512-465f-9d4c-a32883038132",
"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-07T20:56:01.6559728+00:00",
"due_date": "2026-05-07T20:56:01.6559728+00:00",
"date_create": "2026-05-07T20:56:01.6559728+00:00",
"date_update": "2026-05-07T20:56:01.6559728+00:00",
"date_closed": "2026-05-07T20:56:01.6559728+00:00",
"suggested_user_id": "d07e18f7-f69f-4f02-b950-e117997e263e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5b789b5-4b7b-4215-a75b-87cff5eac0f0",
"db_language_id": "ef2db391-521a-4a81-82fd-65874ec9331b",
"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-07T20:56:01.6559728+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2c7de7da-313e-45c8-8986-725ebdd778e9",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7096d68d-cef1-44d0-bc2e-4c1b7c4a83ce",
"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": "0380389c-27c0-4583-ab7e-61c2c07b88c1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bca0227d-9678-4bc8-94b0-0f984dc522d4"
},
"suggested_date_start": "2026-05-07T20:56:01.6559728+00:00",
"skill_id": "3cf9bac7-c901-4ee5-8418-e880801eeb1f",
"skill_code": "sample string 32",
"skill": {
"id": "db37d8ca-392b-41a2-aac5-0d3b9652fcb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4750ab69-f4d9-4471-83ed-03dda9383ee6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a63ba674-a7f8-447d-92ce-a20ad55a3240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "663e8f2b-9b48-4347-90e8-e07dca8e6d42",
"db_currency_id": "cd5b2f05-e12a-4a5d-91bc-746229116bc9",
"db_language_id": "4152aed2-c2a7-49a4-a81c-57541acece58",
"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-07T20:56:01.6559728+00:00"
},
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6c8f912a-0afe-4141-b349-b53b23607ef2",
"date_reported_by_company": "2026-05-07T20:56:01.6559728+00:00",
"id2": 36,
"company_id": "fe4385fe-d5f8-4e5b-ace0-dd2649d22452",
"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": "328151cc-c517-4b68-a660-e9a67a46588a",
"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-07T20:56:01.6559728+00:00"
},
"work_instruction_details_id": "4ca74aa4-04e4-43de-92fc-c1ad10490954",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6b56555c-7836-426d-95de-23ee7334c1b4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5e5f6ae1-0a61-463a-b653-6e5344adfc51",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T20:56:01.6559728+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": "161522a4-a415-4b41-84c7-87567fb06083",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T20:56:01.6559728+00:00"
}