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": "846321f7-64bb-4481-b8e5-2ad3f71f4c83",
"jobs_id": "82a0e23b-fa31-4233-a21c-7602c76bcf88",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "da8ae5cc-ba08-4c3c-9a95-e910567db450",
"_parent_id": "80d42da4-260f-4e1f-b971-44013603abed",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "18d487ec-2fa6-4355-b56a-89d3d33f9ec9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2dc5b35a-ee0c-438c-9e18-43a2d1264470",
"_parent_id": "0bd01506-9e18-45a1-8553-3b4900516210",
"root_parent_id": "df7cad92-edd6-4351-a5ed-4d770a534851",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "463f85bb-1306-4550-8fd3-07f1f9ee0d8e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4b050d1e-9057-4c42-9485-2d17e1c375bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01c64512-01da-4c3c-bf58-3cda89763a83",
"_parent_code": "sample string 6",
"sales_organization_id": "6744afe9-d653-4d6d-87ab-2f0392ee127c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"equipment_model_id": "a91197a7-f4af-41b7-898d-e72f0d024a22",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b9b2f691-25ef-4f91-b9bf-ac16b5d06af4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "16ed7ebe-db2d-4e95-b307-48fd0b46a704",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8d3119e9-3dfc-4377-8db7-cb258406dfe3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9aa49632-9bd1-4899-9f84-7923186d1cf1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"equipment_family_id": "79864dc0-f246-4fcc-8c65-d26e10c34d04",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4b050d1e-9057-4c42-9485-2d17e1c375bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01c64512-01da-4c3c-bf58-3cda89763a83",
"_parent_code": "sample string 6",
"sales_organization_id": "6744afe9-d653-4d6d-87ab-2f0392ee127c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"date_in_production_since": "2025-11-12T23:02:01.0883929+00:00",
"date_out_of_production_since": "2025-11-12T23:02:01.0883929+00:00",
"date_end_support": "2025-11-12T23:02:01.0883929+00:00",
"sales_organization_id": "b08391a0-10bc-4eb1-ad30-e3b403005c54",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+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-11-12T23:02:01.0883929+00:00"
},
"project_status_id": "47ebaaa7-e9cb-4ee8-bad8-ac5d2256d886",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6a10d36-88fb-4544-98bb-3a6d29bb52c0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "19778164-fb2e-44b3-8505-2dbc560664d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"company_id": "a894b4aa-b4f4-4991-b060-bd2d14c4c2b7",
"company_code": "sample string 12",
"db_address_id": "5f07066c-6043-4836-8b86-4d2a883cb881",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "79c4d769-a7b7-43cf-9e66-b51130ca7441",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "262a19ac-854a-43bf-8ab7-47a209127cdc",
"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-11-12T23:02:01.0883929+00:00",
"date_create": "2025-11-12T23:02:01.0883929+00:00",
"date_update": "2025-11-12T23:02:01.0883929+00:00",
"updated_by_user_id": "6e565d9f-b12a-4b6e-85e5-1c97057d458e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T23:02:01.0883929+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-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T23:02:01.0883929+00:00",
"date_last_job": "2025-11-12T23:02:01.0883929+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T23:02:01.0883929+00:00",
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ecd57b0-5305-4644-946a-0d366db6687d",
"job_type_code": "sample string 7",
"job_type": {
"id": "c950d52d-fbf6-4eea-b217-5e359c758a77",
"name": "sample string 2",
"sales_organization_id": "99ad6310-4d57-47a3-854a-373646bd3470",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00",
"code": "sample string 7"
},
"job_priority_id": "57073936-54a7-4240-9dca-c2d6d2faea89",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c39f32dc-d131-4057-a313-fc42510a2a67",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd492ba9-c9be-4ba7-965f-822555387b7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"job_status_id": "623fce3d-bda4-48ee-a045-26fd86703776",
"job_status_code": "sample string 11",
"db_address_id": "4697969f-ae2e-4d14-9310-18484c7a6502",
"contact_id": "b17c4d7e-e375-493b-94b1-679c791c47c3",
"requested_by_company_id": "33f59950-5c39-46f0-8195-ab8aea64fc2c",
"requested_by_contact_id": "6106a54a-a1c9-4b88-908c-bdc253abdac0",
"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-11-12T23:02:01.0883929+00:00",
"due_date": "2025-11-12T23:02:01.0883929+00:00",
"date_create": "2025-11-12T23:02:01.0883929+00:00",
"date_update": "2025-11-12T23:02:01.0883929+00:00",
"date_closed": "2025-11-12T23:02:01.0883929+00:00",
"suggested_user_id": "8e00d9c7-99c0-4b84-82f5-c44eb8f49bac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "70323b91-e39d-4b6f-8cb8-9a12441d1f96",
"db_language_id": "ffaa9fe3-9ec2-4bf8-9f7a-e9420d7259c1",
"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-11-12T23:02:01.0883929+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "86041bf6-5ccb-49c2-8e62-db7ed7f452b0",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c3ae5136-8f4d-4707-b4ec-76e62d35c05d",
"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": "eeb5e14b-d61d-476a-bd21-f243be991c3f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9fd11330-8a0f-440d-8ca9-fe52cc564faf"
},
"suggested_date_start": "2025-11-12T23:02:01.0883929+00:00",
"skill_id": "269d1b52-bb62-40a0-87c3-cecf773a5d17",
"skill_code": "sample string 32",
"skill": {
"id": "29cc8eba-1bdd-43e9-a5f6-b33cf6ea1900",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "80801674-d23b-4a48-a575-754314d99082",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1155f2d-fd2f-47e5-80a7-07647488980d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89639a46-3b9d-4fda-827a-bdde8b805c7a",
"db_currency_id": "2bd1cca0-322a-4977-ab82-2e592c702d78",
"db_language_id": "5dc8f539-674c-48f5-a546-4a3bbee9cf9a",
"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-11-12T23:02:01.0883929+00:00"
},
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "71b49946-6766-479d-96b0-e3320d2a5af8",
"date_reported_by_company": "2025-11-12T23:02:01.0883929+00:00",
"id2": 36,
"company_id": "ef4d9716-058e-4b03-9dd6-18cc6792a345",
"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": "8ed0ca1b-26d2-4dc1-a152-ef5a3625da92",
"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-11-12T23:02:01.0883929+00:00"
},
"work_instruction_details_id": "c078b21b-3034-4c21-8e76-fed5e48148d7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "31120dc1-97ca-4253-a5f8-58ced92a6600",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "05e85fe6-fc48-4d95-ad43-d8ee79ae00f1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-12T23:02:01.0883929+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": "589c323d-1a5a-49a5-98d8-43b841090f2a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-12T23:02:01.0883929+00:00"
}