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": "b3ecd9a2-4a16-4ffb-8f45-cfdce63b211a",
"jobs_id": "1e2f80c1-6c76-47ea-833b-fe4e68ca8b4a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "21b630f9-4efd-4a4f-b8bd-a2cead5a3204",
"_parent_id": "abce6f6f-b443-44ef-a165-5904849a6f58",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bd4f1ed6-efaa-4f73-949c-e7fe3103134f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "55e79f90-4bef-4983-a839-98e0158fc61e",
"_parent_id": "74193edd-c12e-4704-b47c-f4de8f7e2e16",
"root_parent_id": "017f2a4c-55d6-40fa-b310-3add9c237fba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "99b1e5d7-5560-4000-be46-b9ec73584d36",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7b17c9c9-923a-4c7f-8c64-5b06ca6b3d1d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ac12812-5bb6-4d2d-a144-fbcd4e8e79e2",
"_parent_code": "sample string 6",
"sales_organization_id": "487d3aa2-fc45-4248-8a93-33dd82d5efd8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"equipment_model_id": "7d13afb1-00c7-4517-b262-cdd1234370f2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "688ba045-919b-4fed-9146-194e0a7fff9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a5d55bac-f889-4e3b-b90a-d4901e13eb7e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8303c0ba-b628-4e14-929d-c71e50b3d9ea",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "085a3369-fdf2-418d-87e7-a4dfc6628280",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"equipment_family_id": "1772a185-bad1-470d-a221-3280555dfcfc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7b17c9c9-923a-4c7f-8c64-5b06ca6b3d1d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ac12812-5bb6-4d2d-a144-fbcd4e8e79e2",
"_parent_code": "sample string 6",
"sales_organization_id": "487d3aa2-fc45-4248-8a93-33dd82d5efd8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"date_in_production_since": "2026-09-25T00:37:19.7114423+00:00",
"date_out_of_production_since": "2026-09-25T00:37:19.7114423+00:00",
"date_end_support": "2026-09-25T00:37:19.7114423+00:00",
"sales_organization_id": "f8f4bb3f-a1d4-499d-b7f6-58204dc30fd4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+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-09-25T00:37:19.7114423+00:00"
},
"project_status_id": "e2e5daf5-aa45-4c68-8f20-b170b7cf9456",
"project_status_code": "sample string 10",
"project_status": {
"id": "de594ba5-5951-4659-b54b-3332e089887c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "51f06812-6c5b-40ee-a6ec-a70968d937d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"company_id": "af613720-45a6-4347-854b-7eef724ba1d1",
"company_code": "sample string 12",
"db_address_id": "7b52082c-9f8c-4d39-981f-7e40c6f3a61e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "04a47517-e152-4cd1-b4ab-75b9f6702830",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08dcc079-4d38-465b-bd5a-527ac5e0980a",
"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-09-25T00:37:19.7114423+00:00",
"date_create": "2026-09-25T00:37:19.7114423+00:00",
"date_update": "2026-09-25T00:37:19.7114423+00:00",
"updated_by_user_id": "c23f35f5-b379-4a80-8bf8-94f0a0d0bedc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-25T00:37:19.7114423+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-09-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-25T00:37:19.7114423+00:00",
"date_last_job": "2026-09-25T00:37:19.7114423+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-25T00:37:19.7114423+00:00",
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00",
"is_mobile_installation": true
},
"job_type_id": "efc9f46d-e7d7-4576-a7e2-b490e23951d8",
"job_type_code": "sample string 7",
"job_type": {
"id": "ed9ed374-fb7d-4fe1-b08d-07b3fa0863b5",
"name": "sample string 2",
"sales_organization_id": "a7e3bdcc-f30b-46a9-9f50-3094cb92b4d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00",
"code": "sample string 7"
},
"job_priority_id": "fd1600b5-9b6d-4529-8cee-a33ac3e94bb4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70490bb5-6465-4288-82f0-9edbe58efb80",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f0cab120-b6df-4dff-8c15-b91197afc9e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"job_status_id": "2af37d7b-fdef-43eb-9914-62f6d20efd19",
"job_status_code": "sample string 11",
"db_address_id": "353c6c3b-8338-4bfb-9376-3ee2d5c228ff",
"contact_id": "a877381e-18e0-492f-8870-6c84c450ecae",
"requested_by_company_id": "cd3737cc-9d04-4f86-9db3-594fa6349370",
"requested_by_contact_id": "05ec3fb4-a492-4606-ae30-a1cd40290b7b",
"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-09-25T00:37:19.7114423+00:00",
"due_date": "2026-09-25T00:37:19.7114423+00:00",
"date_create": "2026-09-25T00:37:19.7114423+00:00",
"date_update": "2026-09-25T00:37:19.7114423+00:00",
"date_closed": "2026-09-25T00:37:19.7114423+00:00",
"suggested_user_id": "4590b252-0d9a-440d-b9aa-73dd995f463f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e294f3f6-16ae-4b65-9eeb-79855e30e4a1",
"db_language_id": "e75bf437-c48b-47d7-9a9c-5ca878ed76fc",
"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-09-25T00:37:19.7114423+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc7e90a9-8c87-4e7b-8be1-328107225742",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "02ea6cdc-b3b7-45bc-9542-4cb8d3ce84ff",
"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": "cfce5582-12f4-429b-8a66-0f0e61038ecc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2c9af0de-fd90-49b3-87c4-1ff0c8e8a65a"
},
"suggested_date_start": "2026-09-25T00:37:19.7114423+00:00",
"skill_id": "cfe37dac-8f80-4e9a-a1c6-ea6161ea1d1a",
"skill_code": "sample string 32",
"skill": {
"id": "75ca2bab-7cd3-45f8-b7c1-8fa928acdd58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "873f8fe6-aeaa-405b-8bc8-3aef27a63883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40a288d7-3391-41b9-af8b-32a5ef86b889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ceb1776-c303-4149-b9cd-76b4df6dd37c",
"db_currency_id": "e10f7b30-933f-48da-b363-141d352cfa30",
"db_language_id": "d4a36ff8-a4e1-4e68-93f8-fd2506641b21",
"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-09-25T00:37:19.7114423+00:00"
},
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d9c7b669-3bcf-4625-9f5d-87a3931ebcb2",
"date_reported_by_company": "2026-09-25T00:37:19.7114423+00:00",
"id2": 36,
"company_id": "3e75b6b6-34f4-4894-b3e0-08fbd3573b0d",
"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": "1441296a-4592-4316-8d45-48cbbdafdd2e",
"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-09-25T00:37:19.7114423+00:00"
},
"work_instruction_details_id": "6b6a0857-7b35-4a70-b10c-aa8f53d88d04",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f430d639-ad8a-4a18-a452-cfbcacb65043",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e6dd8963-1c16-40ff-9ce3-ee03407f1944",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-25T00:37:19.7114423+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": "f62b766f-5ba7-4335-83b7-4ee92092ae33",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-25T00:37:19.7114423+00:00"
}