Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "76f1d2c3-d899-4943-a752-6500921c37a5",
"jobs_id": "22793cf8-253c-47c3-a77f-4b20fb351bfb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "04cea60d-c330-4223-b20f-df6a9d160352",
"_parent_id": "4e178cfa-f451-4d0a-b94c-ed9da8d372a8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a026f9c0-f027-4e83-9704-682d84233ac9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ca63bfc9-a8d0-49be-9a42-a3d61962ba62",
"_parent_id": "25657a91-6e55-4f0b-bc23-a66444631d10",
"root_parent_id": "66cc23d4-1309-4988-94c5-30434d6ad719",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "662c4f7a-efa1-46d0-beeb-ba47dfaa0eb4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "94dbde9a-e74b-4494-a88b-fa5c1ebecb55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0e38028-323f-4bab-9bae-9d274668ab58",
"_parent_code": "sample string 6",
"sales_organization_id": "094618ce-cf6f-480b-8d75-cfb552b5dedd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"modified_dateutc": "2026-10-06T07:23:23.6036083+00:00"
},
"equipment_model_id": "6d020686-e842-4f2b-ae39-fa4ba78dfd8d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b62ec4dd-bb3d-4345-b15b-6a46a811e452",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eb64903e-48ed-4548-b5cb-987bcd50ba0f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "95c349a5-9b8d-4120-b9f1-2310a788e7fb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6800bd07-c72b-43d9-b867-e3dec4f11e53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"modified_dateutc": "2026-10-06T07:23:23.6205914+00:00"
},
"equipment_family_id": "1d77fc76-68cf-49c1-89b5-830c8850b269",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "94dbde9a-e74b-4494-a88b-fa5c1ebecb55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0e38028-323f-4bab-9bae-9d274668ab58",
"_parent_code": "sample string 6",
"sales_organization_id": "094618ce-cf6f-480b-8d75-cfb552b5dedd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"modified_dateutc": "2026-10-06T07:23:23.6036083+00:00"
},
"date_in_production_since": "2026-10-06T07:23:23.6205914+00:00",
"date_out_of_production_since": "2026-10-06T07:23:23.6205914+00:00",
"date_end_support": "2026-10-06T07:23:23.6205914+00:00",
"sales_organization_id": "c4c2d28c-2db9-4b89-b7b5-48f05d557acd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+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-10-06T07:23:23.6205914+00:00"
},
"project_status_id": "af126303-3f42-4597-b954-31cb4ff719f1",
"project_status_code": "sample string 10",
"project_status": {
"id": "948f7440-7192-4aec-94f3-e1585035cd5f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a3396686-2a84-48bd-b516-5644cad48c84",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T07:23:23.6205914+00:00"
},
"company_id": "ca316b30-6ee9-44d6-a343-024dd96ec538",
"company_code": "sample string 12",
"db_address_id": "b4bb9f54-ad1e-4327-b309-94182dfec852",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0fee2f5a-e169-4c2a-af3d-6f325324ac77",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3fa3bd58-518d-4b13-aafb-727de8dc20fb",
"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-10-06T07:23:23.6205914+00:00",
"date_create": "2026-10-06T07:23:23.6205914+00:00",
"date_update": "2026-10-06T07:23:23.6205914+00:00",
"updated_by_user_id": "07aada2a-7255-4505-93e1-4b3bfcb3506e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T07:23:23.6205914+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-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T07:23:23.6205914+00:00",
"date_last_job": "2026-10-06T07:23:23.6205914+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T07:23:23.6205914+00:00",
"modified_dateutc": "2026-10-06T07:23:23.6205914+00:00",
"is_mobile_installation": true
},
"job_type_id": "376c241f-d0bb-4cd2-ab16-60e35376c666",
"job_type_code": "sample string 7",
"job_type": {
"id": "e9887b1f-c464-44c4-b8cf-d560955c3c2a",
"name": "sample string 2",
"sales_organization_id": "7f5a43ae-2036-42bb-8e93-1127d4670dbb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T07:23:23.6205914+00:00",
"code": "sample string 7"
},
"job_priority_id": "80db1d83-a7d5-4fef-b7a0-309b81cb9298",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "10d795d4-51b8-4e2c-a3cb-e2ef9c89c23d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "707023c1-deec-489a-a05a-6f7645a2762d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T07:23:23.6475912+00:00"
},
"job_status_id": "c3c030db-a641-4199-bac3-c65ca1349e27",
"job_status_code": "sample string 11",
"db_address_id": "0b9bde1f-8f53-4523-9417-506c9276cfda",
"contact_id": "81aa6236-95f9-48a8-8943-6697f008dd37",
"requested_by_company_id": "e2cfb48f-5977-4471-961b-94946b6fa724",
"requested_by_contact_id": "4f28fafb-1043-4e8a-a6b3-75b26fe19ae1",
"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-10-06T07:23:23.6475912+00:00",
"due_date": "2026-10-06T07:23:23.6475912+00:00",
"date_create": "2026-10-06T07:23:23.6475912+00:00",
"date_update": "2026-10-06T07:23:23.6475912+00:00",
"date_closed": "2026-10-06T07:23:23.6475912+00:00",
"suggested_user_id": "416f866d-c8d5-4dc6-ab72-6c2e712267e7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4c0929d4-7e4c-416b-8a57-47a10bca5bd7",
"db_language_id": "fbf2600d-7822-48d8-8bc1-19f107e0952f",
"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-10-06T07:23:23.6475912+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "96e8769d-7614-4567-9847-245214401086",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d6218403-176a-4b30-a3be-b784f93c6427",
"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": "c202d3bb-8a5f-4e94-93cb-592558a4040f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T07:23:23.6475912+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c95c82b0-b773-4d9f-977d-b8237458277e"
},
"suggested_date_start": "2026-10-06T07:23:23.6475912+00:00",
"skill_id": "aab45516-7dc6-4241-9ccf-422a7edab7a7",
"skill_code": "sample string 32",
"skill": {
"id": "7f9be0ec-22cb-4340-8595-00b8a4a1fa2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0b266167-4265-41c3-a30f-5861bd066b94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baf1b6f3-9f0b-4933-b3e7-41a11336310b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed403247-6b97-43ed-b4f6-fd033c91e9f5",
"db_currency_id": "ede6bb3a-a13b-40e8-adae-f576b0279dcd",
"db_language_id": "335e4751-624d-4737-8397-6d0ef941d9eb",
"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-10-06T07:23:23.6036083+00:00"
},
"modified_dateutc": "2026-10-06T07:23:23.6475912+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "39c9a1c2-a6a6-43ae-b2f5-6ae20241cf55",
"date_reported_by_company": "2026-10-06T07:23:23.6475912+00:00",
"id2": 36,
"company_id": "13f395e3-6577-48a6-986a-e6df30300481",
"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": "0fec2316-aae4-40be-8bb8-fb3d8067d30d",
"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-10-06T07:23:23.6475912+00:00"
},
"work_instruction_details_id": "721f3221-6b12-42a7-a54f-f129ce022ad9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6fdb264-653a-414f-9020-361f1623b53a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c8bff947-f919-4beb-97a4-c12f7ca70f9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T07:23:23.6475912+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": "53700910-5b76-435f-a2b2-b998f9da8a2e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T07:23:23.6475912+00:00"
}