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": "52a803f5-fc3c-4d41-be24-e7ac51c13922",
"jobs_id": "3a0a4b7d-efb0-4e8a-a87d-a8e617c6c7bb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1a726f1b-1c05-4c33-a25b-ad11c5652e43",
"_parent_id": "4be1467c-7ed2-4c92-ac0a-7c23df4abd71",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e376a407-9e78-49b8-8274-39f089d32174",
"project_reference_back_office": "sample string 5",
"project": {
"id": "748bcf94-f0e2-4bd1-b9a5-6b84c860c571",
"_parent_id": "0a8ef123-b6ab-4f1b-9204-2ff7eaff410f",
"root_parent_id": "0a8dcb5f-c6e1-4e30-b6b6-3bae74da9691",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c07d2225-aa08-44e9-a96a-0c65409269f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "22b3432f-f83d-4561-8e36-6fc3aa2d7121",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "940514bc-29e0-421f-8e3f-5a3e4cb95d3e",
"_parent_code": "sample string 6",
"sales_organization_id": "d34ba77a-1670-4676-b601-0ee12372eed3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"equipment_model_id": "0fe094e9-e0a4-4ad6-ab6c-66b271953905",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "267b55d1-b494-46e2-9ca8-cf94e8ea4c4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2b20ac45-decf-428f-89d3-03060167d6a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c00f3451-603c-4ae0-8aaf-93357389d897",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ed903acf-326f-4eee-9251-de46010142b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"equipment_family_id": "17383cdb-7e5e-4567-bbdb-9fd8b9bb8e6c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "22b3432f-f83d-4561-8e36-6fc3aa2d7121",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "940514bc-29e0-421f-8e3f-5a3e4cb95d3e",
"_parent_code": "sample string 6",
"sales_organization_id": "d34ba77a-1670-4676-b601-0ee12372eed3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"date_in_production_since": "2025-09-19T02:26:30.3935048+00:00",
"date_out_of_production_since": "2025-09-19T02:26:30.3935048+00:00",
"date_end_support": "2025-09-19T02:26:30.3935048+00:00",
"sales_organization_id": "775f7ce8-b5c7-4b2a-9a3c-0758342b296d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+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-09-19T02:26:30.3935048+00:00"
},
"project_status_id": "2ebd005d-16b6-44e1-9c64-b5ba753293d6",
"project_status_code": "sample string 10",
"project_status": {
"id": "20cc5552-df9f-4fa2-aacb-118d56fbc9f2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0fc8e974-1e8b-4038-9e8f-9bbe8279fe51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"company_id": "ed785b2b-cbc6-49f5-9b73-61bacdd696ae",
"company_code": "sample string 12",
"db_address_id": "8c84d370-79a5-471c-9aea-340ade50fc49",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a0db5cd3-c482-4c3c-90a3-4e291c8c01b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d43a24de-921f-41a5-b7fd-f67d7f07ef58",
"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-09-19T02:26:30.3935048+00:00",
"date_create": "2025-09-19T02:26:30.3935048+00:00",
"date_update": "2025-09-19T02:26:30.3935048+00:00",
"updated_by_user_id": "caa1d523-276f-4450-a485-f877e84af2c4",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-19T02:26:30.3935048+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-19T02:26:30.3935048+00:00",
"date_last_job": "2025-09-19T02:26:30.3935048+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-19T02:26:30.3935048+00:00",
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00",
"is_mobile_installation": true
},
"job_type_id": "361e1f66-2393-4396-8b90-d2e6f72aeb4b",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa46ade7-d5f0-4bbb-8585-f05992c169dd",
"name": "sample string 2",
"sales_organization_id": "95d8895b-2fb7-4b4e-a26c-0ef69270e9da",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00",
"code": "sample string 7"
},
"job_priority_id": "50af89ea-a484-4029-8861-99bcb4688428",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1edfec50-2fa8-4e2a-8abe-559ae28d5d52",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "be55d17d-5d15-4348-a6ca-a97ae7981b6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"job_status_id": "1f18e894-3d93-4447-8a46-60871300e7f7",
"job_status_code": "sample string 11",
"db_address_id": "7543ff7d-2a3d-4335-a2f7-ddbc8b9d8555",
"contact_id": "ec6c54f5-9b3c-4eea-95de-9da3cdbb6ba0",
"requested_by_company_id": "ab78bc5d-e5a3-4d43-a5b3-06f1e4b70e80",
"requested_by_contact_id": "f13b84a9-901e-48cf-b650-ee96904758fc",
"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-09-19T02:26:30.3935048+00:00",
"due_date": "2025-09-19T02:26:30.3935048+00:00",
"date_create": "2025-09-19T02:26:30.3935048+00:00",
"date_update": "2025-09-19T02:26:30.3935048+00:00",
"date_closed": "2025-09-19T02:26:30.3935048+00:00",
"suggested_user_id": "896de131-8961-4887-bf04-2d80738228da",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b9008c97-babb-4d90-a945-11c3777d0f56",
"db_language_id": "c19bab9a-8ff2-43df-a5e9-e18cbf160ac6",
"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-09-19T02:26:30.3935048+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "466094c5-47c4-4396-9c19-0aafcc6d4937",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "404fb1b4-6ed4-4204-a781-c39f66f6ac51",
"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": "038694c2-da63-41bb-b2e2-c7b75aafc2a4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "954d6e3c-0b89-41f7-810f-d4cb7558167a"
},
"suggested_date_start": "2025-09-19T02:26:30.3935048+00:00",
"skill_id": "cda03957-4226-4d8c-9e41-63807f828d9d",
"skill_code": "sample string 32",
"skill": {
"id": "6e7c8a67-80b4-468a-94f3-925bda63cf1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "23accd21-54d6-4a87-be78-43d5c20bf946",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6af7bdf3-9046-4f68-876e-883afa658405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dac905e9-357e-49c1-a604-a197974c9431",
"db_currency_id": "51bb9528-f469-4d30-865a-f7e817de8b0c",
"db_language_id": "7884bdb0-6bf0-4942-8b11-0b5bf0e8877b",
"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-09-19T02:26:30.3935048+00:00"
},
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a409ba64-13eb-4188-8afa-f2ad9f104583",
"date_reported_by_company": "2025-09-19T02:26:30.3935048+00:00",
"id2": 36,
"company_id": "f33cdc90-5e3c-4297-90ee-f535564b3aba",
"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": "a4d853e4-bc35-48aa-a57c-527e92c3f439",
"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-09-19T02:26:30.3935048+00:00"
},
"work_instruction_details_id": "fd065c96-e75e-439b-b504-89a662fb0b5f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b102892d-a15c-40e8-a7c1-4f65bd2151a7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3a7a7cbc-d7a3-4fa2-ac51-475b96a2e3c8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-19T02:26:30.3935048+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": "60df9e2a-fd36-498a-a21c-dd0f99c85067",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-19T02:26:30.3935048+00:00"
}