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": "3de84ebb-cc30-4b3b-b5e5-f17b06505021",
"jobs_id": "79343a06-3094-4c56-8e68-8a48740af5a9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2c663ed0-fef7-4e31-98e4-94a2b4d34a8a",
"_parent_id": "31ef6c19-ad95-4d19-8ce8-09aba2752f90",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cd879f94-4c4c-4b46-83ba-294cf8a3dc47",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1f5415a2-9f66-4d37-9b5f-24365d234d08",
"_parent_id": "e73226b5-3014-4312-b538-93e1eb06b47f",
"root_parent_id": "049604ad-fc8a-4abe-b877-64a783f163d5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0bd0d83-a2ab-49b4-855e-ecff9e6aa926",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "88bddfaf-adfa-45a8-bbad-9b94a7af04d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5a07794-20d4-42a2-8a40-4afde90bf9c2",
"_parent_code": "sample string 6",
"sales_organization_id": "d7d2b51f-0790-4f53-89aa-38d9ee641a64",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"equipment_model_id": "d44e9a7b-1c33-4142-806e-19177a14dbe3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f4fe533a-fe54-4052-8d99-6bc6d9360022",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d24e2a21-5f14-4e1d-9a1e-b96e5e2bee7d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c91a8830-23a5-4711-90dd-a8d2f86519cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "031073da-c1a3-4750-a247-21c5979dead3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"equipment_family_id": "c38627a6-31b5-4837-902c-e920296d2b35",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "88bddfaf-adfa-45a8-bbad-9b94a7af04d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5a07794-20d4-42a2-8a40-4afde90bf9c2",
"_parent_code": "sample string 6",
"sales_organization_id": "d7d2b51f-0790-4f53-89aa-38d9ee641a64",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"date_in_production_since": "2026-02-08T12:52:43.2342856+00:00",
"date_out_of_production_since": "2026-02-08T12:52:43.2342856+00:00",
"date_end_support": "2026-02-08T12:52:43.2342856+00:00",
"sales_organization_id": "dde28116-5bdf-43a1-b269-cc8d134e8cae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+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-02-08T12:52:43.2342856+00:00"
},
"project_status_id": "a161bef8-9a6d-4058-841b-92311849ab0a",
"project_status_code": "sample string 10",
"project_status": {
"id": "862dfba2-c87b-4210-8814-71a05cd77c43",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66ec98b6-6d7e-41c8-b738-8830bb934786",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"company_id": "561d9d4c-229b-420f-842d-ea3d487e3bc4",
"company_code": "sample string 12",
"db_address_id": "4c6de9b8-1efb-48cf-a0f6-874cc16a4a21",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "19057e53-b4cd-48b2-aaa5-4b15a9007296",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "109bcb9d-0df3-4106-bc39-d0f3e41ece68",
"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-02-08T12:52:43.2342856+00:00",
"date_create": "2026-02-08T12:52:43.2342856+00:00",
"date_update": "2026-02-08T12:52:43.2342856+00:00",
"updated_by_user_id": "36dadcca-fb98-4753-968a-dff362f71fd6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-08T12:52:43.2342856+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-02-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-08T12:52:43.2342856+00:00",
"date_last_job": "2026-02-08T12:52:43.2342856+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-08T12:52:43.2342856+00:00",
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00",
"is_mobile_installation": true
},
"job_type_id": "fad2883a-6d1f-4b3a-866a-508c7bc8bd41",
"job_type_code": "sample string 7",
"job_type": {
"id": "4f4da393-7058-4357-9012-5a0196235978",
"name": "sample string 2",
"sales_organization_id": "189c72ab-ff95-4969-82f2-d9e85b706976",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00",
"code": "sample string 7"
},
"job_priority_id": "5420626b-63d7-4727-aa7b-0bb5ae3c6225",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a9b173ad-ffe3-46cf-bd71-9a57b460f3eb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f992a931-4cd0-4198-afbf-842c5098c339",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"job_status_id": "29c6d3d3-5ef9-4e8c-8352-f001ff247ca8",
"job_status_code": "sample string 11",
"db_address_id": "b1656c94-8292-4962-9c68-1ac0516e4522",
"contact_id": "69d55423-ab50-4e76-bfaf-3511d9ac83fc",
"requested_by_company_id": "3b7ddb11-5559-4786-b322-572036a0b9dd",
"requested_by_contact_id": "8463b577-d8d5-426c-b1be-620f1408f84b",
"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-02-08T12:52:43.2342856+00:00",
"due_date": "2026-02-08T12:52:43.2342856+00:00",
"date_create": "2026-02-08T12:52:43.2342856+00:00",
"date_update": "2026-02-08T12:52:43.2342856+00:00",
"date_closed": "2026-02-08T12:52:43.2342856+00:00",
"suggested_user_id": "4635d43f-e6f8-4135-81fa-6ae1ea533bb8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f3955a80-c6dd-46c1-b9bb-aaf80ee5fa3b",
"db_language_id": "caf64bc9-1c73-4e47-a123-0695f7ccecb9",
"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-02-08T12:52:43.2342856+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b48ef7e2-aa3c-4e84-a3c5-a40044e869c3",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8cfa9b2-8546-49bf-b01b-21666078a744",
"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": "a3574559-092f-4348-9f17-113f8b1df283",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9711e72e-bb0b-46dc-bd64-dda9cf5e11d5"
},
"suggested_date_start": "2026-02-08T12:52:43.2342856+00:00",
"skill_id": "82383932-9e4d-4255-8b63-a014080e2043",
"skill_code": "sample string 32",
"skill": {
"id": "3faca0e0-fe24-404a-84fc-256b555992a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "42b34c7f-6511-4451-8a5c-e5ee195aba40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b50503e-9bf8-4da5-bafa-1c3c2c7a1b9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8855e80a-108c-4a91-99b7-aa6a872ef1e2",
"db_currency_id": "8efcd999-4ae5-4dc5-9385-9b0552bad8d5",
"db_language_id": "42ab39ea-6dbd-465b-9d93-7ba843bc2713",
"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-02-08T12:52:43.2342856+00:00"
},
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "26f506e3-90bb-412d-98a6-8d71187e8626",
"date_reported_by_company": "2026-02-08T12:52:43.2342856+00:00",
"id2": 36,
"company_id": "7f8fd160-977c-43aa-a3b9-eaf22096c3e2",
"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": "8bfc9c6b-a017-4816-88b1-1f39b6c65637",
"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-02-08T12:52:43.2342856+00:00"
},
"work_instruction_details_id": "b62677c1-bc9f-4f0e-a173-b1550f9292ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d64a2337-7de0-4507-ae23-8650781bc016",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "28a0fd8b-00e4-44fc-9830-9e5ec21ca0f3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-08T12:52:43.2342856+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": "3c96a153-757c-4c85-9cc5-7147434b01c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-08T12:52:43.2342856+00:00"
}