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": "230d3025-1a1b-4382-b8f5-61db6b712836",
"jobs_id": "aa54beeb-89f3-42cc-9874-2c7c11d25f8a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "be915365-6243-4376-aedf-b48ab979442b",
"_parent_id": "546803a3-dda6-492e-b4b4-88523322d84d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "18d78e2f-50cf-4a3e-8f96-b116136a27a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2489399b-5fcc-4f13-95b6-6f3722f6d8d9",
"_parent_id": "99c6bc52-aedd-4dab-bfb5-3550d14c26b3",
"root_parent_id": "28e384af-7ddd-4eac-a37c-13159b53f05e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1430e9a1-0925-474f-8e6e-41847c07d06b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5fd23a2b-a800-4455-b6b0-b6982ddc0b5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58395e21-17b0-4d85-a14a-8b88e80eeac4",
"_parent_code": "sample string 6",
"sales_organization_id": "bf71e2d9-7198-4cbc-9f7f-81c28ba1ef61",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00"
},
"equipment_model_id": "28b4a9ab-18b2-4c66-8fb9-8534a55c55af",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0f85cc46-694b-44fb-ae57-c0f77d54b07a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d142d9d6-f72c-4ea4-a5e6-510d10b9c2c0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d9baba71-4598-4cc7-be4a-03871e3aa875",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1921b25f-02cf-43e3-ad90-a1d0bb9a2b2b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00"
},
"equipment_family_id": "249e0c59-ce63-408a-9e14-721f7cf6a0a5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5fd23a2b-a800-4455-b6b0-b6982ddc0b5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58395e21-17b0-4d85-a14a-8b88e80eeac4",
"_parent_code": "sample string 6",
"sales_organization_id": "bf71e2d9-7198-4cbc-9f7f-81c28ba1ef61",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00"
},
"date_in_production_since": "2026-06-16T23:05:47.9676893+00:00",
"date_out_of_production_since": "2026-06-16T23:05:47.9676893+00:00",
"date_end_support": "2026-06-16T23:05:47.9676893+00:00",
"sales_organization_id": "3919bbbd-42f3-4df1-9508-7ef50d437b66",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+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-06-16T23:05:47.9676893+00:00"
},
"project_status_id": "448c6f08-875a-49ff-bd75-0f27cab2e262",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e2d2866-be43-460a-ab60-245ca53770a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "920a5117-a1e9-4cee-8daa-7cf092c8ea31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00"
},
"company_id": "7fa0e5f9-9ae0-42e0-b947-f108f013a1d5",
"company_code": "sample string 12",
"db_address_id": "7a88e11b-7946-422b-853a-2b266a239d84",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4fe289f1-af5a-4d7c-bc04-5d29323f9bfa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f8eb3ff3-0a21-462e-a676-5f30de24d76c",
"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-06-16T23:05:47.9676893+00:00",
"date_create": "2026-06-16T23:05:47.9676893+00:00",
"date_update": "2026-06-16T23:05:47.9676893+00:00",
"updated_by_user_id": "817192d0-954b-4756-84e2-0d441edca49f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-16T23:05:47.9676893+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-06-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-16T23:05:47.9676893+00:00",
"date_last_job": "2026-06-16T23:05:47.9676893+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-16T23:05:47.9676893+00:00",
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c45c29a-9bf7-4de8-bfcd-3f81e395b8bb",
"job_type_code": "sample string 7",
"job_type": {
"id": "1eae8d17-6b66-4acf-b364-c364071d5c20",
"name": "sample string 2",
"sales_organization_id": "8529f2e4-de4a-463d-9201-86e71dfd172d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00",
"code": "sample string 7"
},
"job_priority_id": "6228f0cb-f83d-468d-91b7-ff98c06aac64",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c92b2e41-4167-4a1a-813a-585d12635413",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b41f69e5-8c94-45a1-a70e-77040e0cf059",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00"
},
"job_status_id": "fc306937-d442-4370-a674-33d20253c39c",
"job_status_code": "sample string 11",
"db_address_id": "73dedc39-f515-4ce0-8426-cabcf913539d",
"contact_id": "51712226-9eac-4d05-94a0-e4476d76359a",
"requested_by_company_id": "5ca7905d-3a35-4de2-a57e-96ae094831c8",
"requested_by_contact_id": "600efce6-c11c-4d19-8542-e3087cedb5c3",
"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-06-16T23:05:47.9676893+00:00",
"due_date": "2026-06-16T23:05:47.9676893+00:00",
"date_create": "2026-06-16T23:05:47.9676893+00:00",
"date_update": "2026-06-16T23:05:47.9676893+00:00",
"date_closed": "2026-06-16T23:05:47.9676893+00:00",
"suggested_user_id": "360582ee-7b95-4c2f-8642-138ece2d1947",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a5900013-9af4-4406-8762-5baecbe4b0e3",
"db_language_id": "8a6e85c4-784d-4396-949c-0266db2d1f86",
"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-06-16T23:05:47.9676893+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ec81d8d7-1c51-424a-9be5-b2c4660052f4",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "968c0dd4-f92c-4d9b-a554-4b5f44665fb7",
"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": "98f0c0f3-9b34-437e-bd40-4102da55f78e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-16T23:05:47.9676893+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2579a3c1-5434-43e6-827b-ed9779014737"
},
"suggested_date_start": "2026-06-16T23:05:47.9833122+00:00",
"skill_id": "0e18376e-fb27-4bc6-8baa-af4815faf69a",
"skill_code": "sample string 32",
"skill": {
"id": "970b74b8-8c32-4cdc-94c5-ad53575eebbb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7f6bc183-306f-4863-8a81-4b07bc09d77a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8f693dd-03a1-41c9-9649-5034c69c8824",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24f061c8-e497-4784-aa9d-96ad39a2fd45",
"db_currency_id": "e46bfc12-3c11-477e-9449-9905a08da271",
"db_language_id": "ce9c2888-baec-4d00-97d6-f74268e162df",
"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-06-16T23:05:47.889562+00:00"
},
"modified_dateutc": "2026-06-16T23:05:47.9833122+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "866e9914-f0dd-4939-b103-376937309073",
"date_reported_by_company": "2026-06-16T23:05:47.9833122+00:00",
"id2": 36,
"company_id": "a09a9a43-362b-469a-b2e6-d47757f2e27f",
"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": "fc683d1b-a297-498f-946d-d0555341a6f4",
"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-06-16T23:05:47.9833122+00:00"
},
"work_instruction_details_id": "67c76aef-1f35-4af3-8a8c-50a95438a02a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6882ca41-433d-488a-b7a8-6fdcda0da992",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "40966a9b-9a31-478f-9765-86c663ca4552",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-16T23:05:47.9833122+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": "f32f814e-7832-4d69-abfa-0ebf86f9a57e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-16T23:05:47.9833122+00:00"
}