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": "63af5bbd-7cdf-4b98-8007-5f7d61b6d94b",
"jobs_id": "03dad7ec-d94a-44bf-82bd-b5bd9e69fb1b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9824bc1e-01f6-4b00-bac1-8fbdd8638a17",
"_parent_id": "7f93b0ac-e1df-4586-9978-875fa0cae2ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b34922e3-94d7-49be-ad05-24c06d944d8c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "880174c9-b220-4555-852b-56252cb77b35",
"_parent_id": "67d19673-1437-49cf-8adc-1230a0d7b1a1",
"root_parent_id": "49557a93-e529-4e56-a6cc-b451ee7e2483",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0dd603ff-5520-45f2-9ef1-0e3bb391d510",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6004eee4-0092-4110-948c-ff135d2d25a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd359527-4d2e-4788-8e00-d474199c05f3",
"_parent_code": "sample string 6",
"sales_organization_id": "6cfc3cba-f122-45f3-8c6d-6ab61c58ab9d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"modified_dateutc": "2025-10-14T09:24:52.7545333+00:00"
},
"equipment_model_id": "cfa5bc5c-ec59-4ead-a1f4-8bc580b53881",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f8babb31-09d4-43a1-b5bc-bcd90afff243",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5725dd7a-d25f-4bd1-a222-c085d0d6d897",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "88a70150-73f9-4c12-a1ed-b19bc9d43d4c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "104b8c3c-376c-4f3f-b0c7-297a64097140",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"modified_dateutc": "2025-10-14T09:24:52.7545333+00:00"
},
"equipment_family_id": "37f704e9-0357-4ea6-9c6f-e18a67f811a0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6004eee4-0092-4110-948c-ff135d2d25a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd359527-4d2e-4788-8e00-d474199c05f3",
"_parent_code": "sample string 6",
"sales_organization_id": "6cfc3cba-f122-45f3-8c6d-6ab61c58ab9d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"modified_dateutc": "2025-10-14T09:24:52.7545333+00:00"
},
"date_in_production_since": "2025-10-14T09:24:52.7545333+00:00",
"date_out_of_production_since": "2025-10-14T09:24:52.7545333+00:00",
"date_end_support": "2025-10-14T09:24:52.7545333+00:00",
"sales_organization_id": "0eea4f1b-ed09-4957-87b8-12125143d44e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+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-14T09:24:52.7702763+00:00"
},
"project_status_id": "3a1ebe69-39db-45ec-a9db-338d80cf3f9b",
"project_status_code": "sample string 10",
"project_status": {
"id": "8010178e-8ddb-4a55-9f2f-014d15ec4562",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "71e15987-5382-4b0f-89e4-56c84a55ea53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00"
},
"company_id": "a9ad7008-9c82-4076-96e0-19307c214bf9",
"company_code": "sample string 12",
"db_address_id": "59a94a12-4722-449f-8d94-6ba18f6894ff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9364cc9c-4861-4dd0-adcd-027b1ca32487",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9e91284-39dc-4447-970b-ac730eb6c1d8",
"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-14T09:24:52.7702763+00:00",
"date_create": "2025-10-14T09:24:52.7702763+00:00",
"date_update": "2025-10-14T09:24:52.7702763+00:00",
"updated_by_user_id": "58f976fa-c963-431f-8bd7-940ab3b6817a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-14T09:24:52.7702763+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-14T09:24:52.7702763+00:00",
"date_last_job": "2025-10-14T09:24:52.7702763+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-14T09:24:52.7702763+00:00",
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00",
"is_mobile_installation": true
},
"job_type_id": "8af41418-0cbc-4cb9-8ce3-dad020be32fd",
"job_type_code": "sample string 7",
"job_type": {
"id": "0d831983-1d85-4e26-ad0e-2f354cfd4912",
"name": "sample string 2",
"sales_organization_id": "857054d0-1e1c-4527-abf7-5951ce894543",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00",
"code": "sample string 7"
},
"job_priority_id": "011882f3-9a63-4022-8b4d-0177a2e693b6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b8e9e67e-8716-405f-8e42-7b87b0c2017f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d3a94b25-fcb3-4f93-9da1-72908d849367",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00"
},
"job_status_id": "1497e84d-85a2-43b2-a36e-78fd31911536",
"job_status_code": "sample string 11",
"db_address_id": "1e8987ac-7501-45f8-a512-65695fd31363",
"contact_id": "2372f397-d9c8-4d5d-9944-b14d7df9d64f",
"requested_by_company_id": "005277d5-96c9-4a2b-841c-78adc31b4c9a",
"requested_by_contact_id": "e3d1f3a4-29e3-4a75-b6f1-6d3ce2b81c3f",
"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-14T09:24:52.7702763+00:00",
"due_date": "2025-10-14T09:24:52.7702763+00:00",
"date_create": "2025-10-14T09:24:52.7702763+00:00",
"date_update": "2025-10-14T09:24:52.7702763+00:00",
"date_closed": "2025-10-14T09:24:52.7702763+00:00",
"suggested_user_id": "56bf1d7a-a9d6-48f6-a37b-ee5da6ae3e08",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6b04148f-97d9-4741-bb98-887dcee77209",
"db_language_id": "c357535c-5845-44b8-bea7-68534b8471c1",
"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-14T09:24:52.7702763+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04d669e4-2201-4c20-afbe-d6b90eafe8a4",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77cba646-81dc-4fe9-b1bc-5d2a24112bd3",
"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": "a26f5c2f-f587-44e9-91e4-418b1756b461",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "522492cb-286c-4d90-9c78-902d93e38395"
},
"suggested_date_start": "2025-10-14T09:24:52.7702763+00:00",
"skill_id": "623c06da-decd-4741-a61d-7cbffaf7e918",
"skill_code": "sample string 32",
"skill": {
"id": "cd287e78-c365-43c3-ab38-69a2234fed18",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "75e32bd8-cb40-4381-ac8b-0dfa11811b38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07cea934-099d-4d73-80bd-1b4263f12e0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b75ec78-5c2a-425e-b9af-37f76724e2a2",
"db_currency_id": "bb0e1956-e450-43a0-81fa-366ab96a777f",
"db_language_id": "cc6e9fcf-8051-4301-95cc-65e844bd2757",
"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-14T09:24:52.7545333+00:00"
},
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f7b63406-efef-4816-9c98-19849094d194",
"date_reported_by_company": "2025-10-14T09:24:52.7702763+00:00",
"id2": 36,
"company_id": "43be3057-53da-46b4-afc3-80c6462dbf97",
"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": "1d818f9c-f40d-42c4-b1a8-881c10f525a1",
"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-14T09:24:52.7702763+00:00"
},
"work_instruction_details_id": "9932cba2-ef1c-43c2-8137-75e1d4690f66",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eb5cbb34-cf83-4bb9-8aa0-19ae230f038d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c4d52abe-43c7-44de-aab9-e1ffd3072e6e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-14T09:24:52.7702763+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": "e88426a7-e65e-4230-a67b-2163d1addb8b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-14T09:24:52.7702763+00:00"
}