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": "098dd394-4751-4fba-a501-ffca3d06ef15",
"jobs_id": "27895bf6-32cf-4981-8a13-c3d0f5af0cc6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0febb3c6-4349-47a1-baaa-90c8a994fc2c",
"_parent_id": "5401ac56-8dec-49c6-b2b8-e1e8b571f9d9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4a5e8e1a-7ad7-4515-aa78-819ee54476d6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c04790d-1f1d-4fd3-86e2-0a65559d3c83",
"_parent_id": "504294ed-83d5-4330-94ad-0ba979217e23",
"root_parent_id": "28a0aafc-2f82-451a-a734-417cecca7807",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "888595bc-3ed0-459e-92bd-f857a87d6b1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "87cc87f4-9113-4fc0-b854-3342906a1937",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e4a221d-e09f-46fb-9963-a2b58e1d14dc",
"_parent_code": "sample string 6",
"sales_organization_id": "18ab106a-f512-4eb6-92cc-34e04fc1b29c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"equipment_model_id": "672fc8aa-4152-4b3a-b058-465cdae611cf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a8b997de-1ce5-4396-9a2b-2e35bf97cfd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55ef1103-e6e0-4f6a-9499-7fdeeceda2d6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b89544fa-4d7f-46fe-871f-fb61d7625800",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b594705b-ec61-44ea-8787-cd0c90f0b1a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"equipment_family_id": "0385f72a-7665-4932-968d-666239044513",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "87cc87f4-9113-4fc0-b854-3342906a1937",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e4a221d-e09f-46fb-9963-a2b58e1d14dc",
"_parent_code": "sample string 6",
"sales_organization_id": "18ab106a-f512-4eb6-92cc-34e04fc1b29c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"date_in_production_since": "2025-10-08T18:24:40.3843941+00:00",
"date_out_of_production_since": "2025-10-08T18:24:40.3843941+00:00",
"date_end_support": "2025-10-08T18:24:40.3843941+00:00",
"sales_organization_id": "449583c8-71ae-4cfb-bbbb-6ac0e46c12c7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+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-10-08T18:24:40.3843941+00:00"
},
"project_status_id": "e9ea1d37-ea54-47cc-a750-89a54308e0af",
"project_status_code": "sample string 10",
"project_status": {
"id": "9ef148a0-6b57-439c-b063-e8e4133cf3cd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66ad2d3d-c638-431b-adbb-daf92a0b7071",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"company_id": "23b1afb7-a6b6-4af6-a6e1-5de5d6667ba7",
"company_code": "sample string 12",
"db_address_id": "bc49dc54-52a5-40cb-be94-f9e67452a192",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16da29be-4d50-4a5b-b06c-b8b065ca8737",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8e7187ed-7055-4221-821b-01900f0d4ec6",
"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-10-08T18:24:40.3843941+00:00",
"date_create": "2025-10-08T18:24:40.3843941+00:00",
"date_update": "2025-10-08T18:24:40.3843941+00:00",
"updated_by_user_id": "3ba9ddc3-a850-4bb7-9ed8-23f3d9780fd2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-08T18:24:40.3843941+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-08T18:24:40.3843941+00:00",
"date_last_job": "2025-10-08T18:24:40.3843941+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-08T18:24:40.3843941+00:00",
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00",
"is_mobile_installation": true
},
"job_type_id": "23adf6e3-bc80-434b-a4a5-64ff12421522",
"job_type_code": "sample string 7",
"job_type": {
"id": "43f03129-e0a5-4926-99d5-7fb673761aa1",
"name": "sample string 2",
"sales_organization_id": "4b7889b1-2096-4acf-be6f-3d936652490e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00",
"code": "sample string 7"
},
"job_priority_id": "dc55c9d9-355a-48db-b5f6-de6e272a1a0c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "76a6b564-4603-4e2a-b020-18bdb9c61c6e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3767d511-3ae1-498a-a220-48a0e899df4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"job_status_id": "3df2709a-6314-4fe8-8bda-69ffc5eaf431",
"job_status_code": "sample string 11",
"db_address_id": "7ec0bc2f-d2da-4803-8773-da61d5755d7e",
"contact_id": "f2aa3743-d3bf-489f-9135-713066760b4a",
"requested_by_company_id": "b1ff5285-4291-4d41-b2f4-a8c3286d7a20",
"requested_by_contact_id": "945aad39-1f5b-435c-8cb9-87cc135e9676",
"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-10-08T18:24:40.3843941+00:00",
"due_date": "2025-10-08T18:24:40.3843941+00:00",
"date_create": "2025-10-08T18:24:40.3843941+00:00",
"date_update": "2025-10-08T18:24:40.3843941+00:00",
"date_closed": "2025-10-08T18:24:40.3843941+00:00",
"suggested_user_id": "4c347426-e011-477b-855b-a4e272228351",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "837036be-6528-42f3-a4ac-0a5275e2eafe",
"db_language_id": "5d4c018e-2976-447b-875f-64ef519b4160",
"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-10-08T18:24:40.3843941+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ae208f8b-033a-43e7-80a9-4219028d6046",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "90307a0e-53b0-4e87-8f00-8cf3c191d444",
"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": "65c6b734-c8d9-46ba-8879-43cb7ac27b62",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6a58fe43-8496-4ba9-a167-5381a6a266bc"
},
"suggested_date_start": "2025-10-08T18:24:40.3843941+00:00",
"skill_id": "b9549ae7-0b30-4493-8b1e-0040adb3feea",
"skill_code": "sample string 32",
"skill": {
"id": "8e455078-e13a-42ab-8e0c-35d68cd8dd54",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "46f810bc-83b0-456d-a0bb-4d8d04195a06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d5b55fe-5509-493e-aa72-10c063b5d18f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19f5d8e0-6b63-4c4c-a827-d4f577f1d909",
"db_currency_id": "bfcb0868-eac3-4579-b5c5-4482011b80e7",
"db_language_id": "70151e1d-29b4-44a2-a38a-1a96d4a4abc9",
"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-10-08T18:24:40.3843941+00:00"
},
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "713b3bee-1472-4831-9b93-f6b2d6257b7e",
"date_reported_by_company": "2025-10-08T18:24:40.3843941+00:00",
"id2": 36,
"company_id": "3d9b9bb8-bade-4fdf-92bd-8c8f27abcc89",
"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": "59419e9c-098f-4ca2-a70f-3f601469f3fd",
"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-10-08T18:24:40.3843941+00:00"
},
"work_instruction_details_id": "db686a0d-e509-4133-bedb-2e79e83b5fec",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8a4ea95a-8343-458b-8772-662e4ef8a193",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "81cd0ffa-9958-45fd-89e9-5c0d43fe1a9e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-08T18:24:40.3843941+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": "78dbb4b7-d65e-4df2-be47-699024217e9e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-08T18:24:40.3843941+00:00"
}