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
{
"id": "e6570e02-524a-4cb2-bcfb-bb7bde00838c",
"jobs_id": "765437b3-357c-4a7b-bc2b-79b332add701",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "33bdfb6e-0756-4166-813e-8a6dcbb82aea",
"_parent_id": "7b4ff22e-67ce-4b43-809c-53d31e8582e4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "73d82edb-caf6-45b0-9fea-53c92bc6107f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ede56d45-1717-49bc-9009-414488530f35",
"_parent_id": "f4000815-995f-4cf8-9f5e-8dcbb0e842f8",
"root_parent_id": "642c7d88-4539-4d83-b577-4ae6a10209af",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "02a4effb-d720-440a-8d93-af18f69fae5e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c1ba97ad-296a-4b1b-a1a9-9b8bccadf6e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87958104-a5ca-48f0-b2a2-311f187b80ed",
"_parent_code": "sample string 6",
"sales_organization_id": "34baf9ae-c9c5-4b33-86bb-ed660865991a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"modified_dateutc": "2026-11-21T00:37:19.5184558+00:00"
},
"equipment_model_id": "853d940e-a5d3-40a2-b55d-2c393bd5f278",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6079778a-8d37-4043-b8d6-4fd79ed52418",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9430f843-7e00-48fc-82bd-7f12d2068916",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "57ad8387-151b-4919-b5eb-35b289ebd56d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dad916a5-3c04-4308-83d2-b7cbe3e3f657",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"modified_dateutc": "2026-11-21T00:37:19.5184558+00:00"
},
"equipment_family_id": "3de516bd-8fbc-420e-a096-8371634e1630",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c1ba97ad-296a-4b1b-a1a9-9b8bccadf6e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "87958104-a5ca-48f0-b2a2-311f187b80ed",
"_parent_code": "sample string 6",
"sales_organization_id": "34baf9ae-c9c5-4b33-86bb-ed660865991a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"modified_dateutc": "2026-11-21T00:37:19.5184558+00:00"
},
"date_in_production_since": "2026-11-21T00:37:19.5184558+00:00",
"date_out_of_production_since": "2026-11-21T00:37:19.5184558+00:00",
"date_end_support": "2026-11-21T00:37:19.5184558+00:00",
"sales_organization_id": "cde489cb-54b4-424c-8d3f-517113a2b505",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+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-11-21T00:37:19.531888+00:00"
},
"project_status_id": "6a3ce000-4728-44ae-977a-ae5508fcccb2",
"project_status_code": "sample string 10",
"project_status": {
"id": "36311758-4204-475e-9d0a-2116d06f3c30",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f170d4d0-05e0-4865-bd73-9c8873b94cf5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-21T00:37:19.531888+00:00"
},
"company_id": "8fa9ebed-b4ff-4e18-81e8-1deae57696fe",
"company_code": "sample string 12",
"db_address_id": "1cd68db2-60ea-4bbc-8c07-994cf05285c8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "33aac553-5687-414e-af87-2e5db3ddf219",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7eb336a5-c258-43c8-b8a5-704c77f9d0f0",
"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-11-21T00:37:19.531888+00:00",
"date_create": "2026-11-21T00:37:19.531888+00:00",
"date_update": "2026-11-21T00:37:19.531888+00:00",
"updated_by_user_id": "9a5fd1de-49b2-4d1e-948b-f71fa76a8739",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-21T00:37:19.531888+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-21T00:37:19.531888+00:00",
"date_last_job": "2026-11-21T00:37:19.531888+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-21T00:37:19.531888+00:00",
"modified_dateutc": "2026-11-21T00:37:19.531888+00:00",
"is_mobile_installation": true
},
"job_type_id": "98c90ff4-4d38-44b6-a430-e69a4dc2b29c",
"job_type_code": "sample string 7",
"job_type": {
"id": "b83f2eae-6c3a-476c-996a-509a0faa973a",
"name": "sample string 2",
"sales_organization_id": "925493c1-e978-4057-8942-f7de4281a693",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-21T00:37:19.531888+00:00",
"code": "sample string 7"
},
"job_priority_id": "edd4849f-9763-452f-9683-32df958ea1cd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "014ac923-b75f-4ef8-9e5e-4ef09e006533",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b85fd8d1-942d-4e70-883c-62b8dd98cb55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-21T00:37:19.5481681+00:00"
},
"job_status_id": "237dfa40-9794-403d-96d7-122fb0c7b213",
"job_status_code": "sample string 11",
"db_address_id": "470924e8-4024-4070-8dd9-dbaffa887266",
"contact_id": "e52e7a92-c01c-4387-8cad-607510b420b5",
"requested_by_company_id": "7f618be3-bc3d-4b91-9d4b-e77ba7989b57",
"requested_by_contact_id": "8cb31d21-e4dc-4fd4-9f7e-20e68ce7271d",
"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-11-21T00:37:19.5481681+00:00",
"due_date": "2026-11-21T00:37:19.5481681+00:00",
"date_create": "2026-11-21T00:37:19.5481681+00:00",
"date_update": "2026-11-21T00:37:19.5481681+00:00",
"date_closed": "2026-11-21T00:37:19.5481681+00:00",
"suggested_user_id": "c5be2158-dc95-4787-b294-76f5bd7abc93",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea400877-8e35-4ac1-bdba-c4296e905755",
"db_language_id": "e0deaf72-9f73-4a1f-91f2-262403f2bd61",
"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-11-21T00:37:19.5481681+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "66fcb322-7b42-4bd7-8f41-55702749fffc",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6b20c543-b20d-4baa-a905-ae65c3e4dd7a",
"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": "c511ef1e-2766-4508-909f-6c994f8e4031",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-21T00:37:19.5481681+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f098e033-fbee-49bf-ad5f-4fdceba16b7c"
},
"suggested_date_start": "2026-11-21T00:37:19.5481681+00:00",
"skill_id": "520b1705-464a-435c-a067-490c1afc1c56",
"skill_code": "sample string 32",
"skill": {
"id": "42314d22-b49f-4da3-9085-74f3d458209d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4cd3dcdc-09cc-45b3-b7cc-fe3b6c347007",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "012d68a1-2752-429b-82b8-08fbb2494401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef8cded8-4ac4-4c5e-875d-a3ae81961aff",
"db_currency_id": "bfe08a2d-f730-4ccf-9e95-eb2a09f2c5ff",
"db_language_id": "7b8ab014-4787-46ba-a075-5b93021688bc",
"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-11-21T00:37:19.5184558+00:00"
},
"modified_dateutc": "2026-11-21T00:37:19.5481681+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "12409bd6-9c3e-44be-a3c4-f1df5a4e88b5",
"date_reported_by_company": "2026-11-21T00:37:19.5481681+00:00",
"id2": 36,
"company_id": "5bc6d78e-be40-4dc7-9094-d639bb71a65d",
"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": "b493e8b3-6e73-4517-aaf8-68b30fe92ad9",
"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-11-21T00:37:19.5481681+00:00"
},
"work_instruction_details_id": "f42a2e6e-bc95-41bc-94f4-2be25375c697",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a6275d7d-48bb-47c9-8e7f-1b5c9af8cbc0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "50b0f0d1-a4dd-4387-864d-d76855215b6c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-21T00:37:19.5481681+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": "1f0c8592-a7d7-4d0f-ad16-19a6ed440469",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-21T00:37:19.5481681+00:00"
}