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": "9bfbb340-fe65-47fb-bf30-b0ed9ee7f1b9",
"jobs_id": "f2525c43-6b22-40bd-911a-60d1163dccfc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b99506b9-71cd-488b-b44e-d62d66190563",
"_parent_id": "72c7f1ac-cbab-4d40-991f-863afb67c855",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7ae1c87a-f4b5-44d9-ba79-b3d66b314f86",
"project_reference_back_office": "sample string 5",
"project": {
"id": "85e7df2f-cee7-4ce1-a414-008c25ba5b28",
"_parent_id": "43090103-3c09-44ea-b98c-5e3f0af33218",
"root_parent_id": "2c7615a1-fb95-478a-98a2-e330f8e6b289",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f51fdf0d-3300-417f-b0f1-8729c8a81f77",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4349e2f4-3301-43da-a589-14face5c388e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1eeea9c7-03c8-48de-835f-d176de975a32",
"_parent_code": "sample string 6",
"sales_organization_id": "2493c725-1a48-4e99-83da-532116b0f209",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"equipment_model_id": "1a195768-190e-400d-9a60-811916f405a4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ee196a4e-6ebe-402c-b907-e9030ebf570b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "efa16bb9-1663-45ad-b91e-62dd0bfe493c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b6345060-0d03-4e2f-afb3-37e0c1ff73b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f819333d-7065-47b6-aaf6-08302b3d8ad0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"equipment_family_id": "738f90cd-d2fa-46d2-8a71-41dc4b4387a5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4349e2f4-3301-43da-a589-14face5c388e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1eeea9c7-03c8-48de-835f-d176de975a32",
"_parent_code": "sample string 6",
"sales_organization_id": "2493c725-1a48-4e99-83da-532116b0f209",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"date_in_production_since": "2025-12-22T08:17:53.587824+00:00",
"date_out_of_production_since": "2025-12-22T08:17:53.587824+00:00",
"date_end_support": "2025-12-22T08:17:53.587824+00:00",
"sales_organization_id": "f0aadc4e-9d64-4bea-8a0b-afc5150bf7cc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+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": "2025-12-22T08:17:53.587824+00:00"
},
"project_status_id": "d9c9795b-59af-4a49-ac2f-56e05d60459f",
"project_status_code": "sample string 10",
"project_status": {
"id": "744ea47d-7b6d-430f-ac4e-030c5d8b6d6c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8247143-4d47-491e-9ed2-1026b4895c93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"company_id": "9e01a84a-8b03-44fb-b946-2d69efb369b8",
"company_code": "sample string 12",
"db_address_id": "0fefefef-41a6-41ed-8f9d-3cfdd3123459",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "964b117c-aa67-4757-bb53-d12eec37c6fe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6e316e1d-ac8f-4140-8367-13ae0f198958",
"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": "2025-12-22T08:17:53.587824+00:00",
"date_create": "2025-12-22T08:17:53.587824+00:00",
"date_update": "2025-12-22T08:17:53.587824+00:00",
"updated_by_user_id": "8ad639cc-7402-4076-b201-ab1bcbbd642d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-22T08:17:53.587824+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": "2025-12-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-22T08:17:53.587824+00:00",
"date_last_job": "2025-12-22T08:17:53.587824+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-22T08:17:53.587824+00:00",
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00",
"is_mobile_installation": true
},
"job_type_id": "715ec4d7-11c5-42ff-bd88-812421ad21b8",
"job_type_code": "sample string 7",
"job_type": {
"id": "4de9a48f-2b07-4bdd-bcf7-23754427244c",
"name": "sample string 2",
"sales_organization_id": "7a93e496-6c67-412e-b02b-e4819c820576",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00",
"code": "sample string 7"
},
"job_priority_id": "ed3391b9-a002-47d4-a77b-364d9a42b53e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2bd4c4f6-d34a-4d89-8803-dcc31c522c6a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f126a50f-736c-4a17-a5b7-c60db1b61744",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"job_status_id": "16464a72-c7b9-45c1-ac03-0147cf2bede1",
"job_status_code": "sample string 11",
"db_address_id": "0d33d3cc-3d17-48cb-823d-0c69cfa61e12",
"contact_id": "bc72a933-23d1-4d0f-8dc3-ea1fdc5c1470",
"requested_by_company_id": "00200878-5162-46a6-b2e3-9f046be9b561",
"requested_by_contact_id": "2feb06f0-9e53-4fa6-9e8d-e8beaa69a9f3",
"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": "2025-12-22T08:17:53.587824+00:00",
"due_date": "2025-12-22T08:17:53.587824+00:00",
"date_create": "2025-12-22T08:17:53.587824+00:00",
"date_update": "2025-12-22T08:17:53.587824+00:00",
"date_closed": "2025-12-22T08:17:53.587824+00:00",
"suggested_user_id": "9ee25787-3d8e-4bb7-9d33-d087bd15f4da",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7605fa14-8d3a-43b9-b8a9-18e4883e50e4",
"db_language_id": "17809aad-e68a-4843-bb60-571b511669bf",
"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": "2025-12-22T08:17:53.587824+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2411cf70-4786-4af3-afa6-480c90959610",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0f1270ca-8895-4e4e-8507-b885953c9a00",
"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": "cf7f8b2e-6e9d-4a69-915d-7bc1b810ef14",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "85905a78-560c-4372-926b-87c3cd38b68a"
},
"suggested_date_start": "2025-12-22T08:17:53.587824+00:00",
"skill_id": "d924ac60-ef52-481c-b999-96023b2f06f0",
"skill_code": "sample string 32",
"skill": {
"id": "7ba6f69d-5c27-4bed-bbe1-20c9a8b65be9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf1048e5-a5df-4a7c-bbf6-cf510843662a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fec7598e-b2be-4f35-9f9c-1b4229171a8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a36ef958-890c-4fed-b23b-acaa7be27762",
"db_currency_id": "d6f6d6e9-e8c1-4771-a53c-fb3ae7dc973d",
"db_language_id": "912f0f3d-1bbe-437c-900d-e36d1d5de992",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"modified_dateutc": "2025-12-22T08:17:53.587824+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "82395f28-d841-44c8-b317-59b9749e0cec",
"date_reported_by_company": "2025-12-22T08:17:53.587824+00:00",
"id2": 36,
"company_id": "52bedc26-42fa-4fa8-9969-7f07d50435a7",
"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": "71b503ea-aeff-4dac-9718-9a53324b6b4a",
"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": "2025-12-22T08:17:53.587824+00:00"
},
"work_instruction_details_id": "37c272d5-ef10-4037-add3-8d7b966948fd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b1e6b603-fc38-4491-b9c7-ae56f9c43e4e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "99960462-05d2-4af7-a173-b15dddf2ae40",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-22T08:17:53.6034484+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": "c6f52cb7-4fa7-4acc-9314-144486456fc0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-22T08:17:53.6034484+00:00"
}