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": "98c0a065-39b0-43ba-bc1a-28a067045140",
"jobs_id": "f278fb61-191b-4313-8324-3eb7fe199e65",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "533360d8-378b-4f02-8117-2898972f8594",
"_parent_id": "6d2fff3a-fee4-41d9-879a-8a0458667c40",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9684ede9-1103-481e-b913-6b4ee263ff6d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "edf35ec3-a41f-4c4a-9474-ab8c5e159da0",
"_parent_id": "636d45fc-7371-4702-86e5-2dea04663d1f",
"root_parent_id": "d68b68f4-385a-4c78-9faf-12c9486e5914",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "68a3c764-d063-4d24-9090-f0f99962adbd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bfcb9ca4-5ace-4a71-9257-4dc32cb61bbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2664bef3-8a0d-449d-ae0a-92b6890ee145",
"_parent_code": "sample string 6",
"sales_organization_id": "02a60609-5304-4378-9c04-fb170ee4a525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"modified_dateutc": "2026-04-18T08:58:55.9251651+00:00"
},
"equipment_model_id": "db1da924-8510-4256-8164-ddb8a6579013",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3c6752c7-cccd-4b15-81b8-11db1715d122",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d7a7d55-aea8-4a17-af02-de1533716ab6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d875f732-b5ea-4710-adac-86bb4e8458fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "386ba892-9e59-406f-901b-45476cf1230c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"modified_dateutc": "2026-04-18T08:58:55.9251651+00:00"
},
"equipment_family_id": "979b4982-ab6d-469b-9985-666a08039193",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bfcb9ca4-5ace-4a71-9257-4dc32cb61bbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2664bef3-8a0d-449d-ae0a-92b6890ee145",
"_parent_code": "sample string 6",
"sales_organization_id": "02a60609-5304-4378-9c04-fb170ee4a525",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"modified_dateutc": "2026-04-18T08:58:55.9251651+00:00"
},
"date_in_production_since": "2026-04-18T08:58:55.9251651+00:00",
"date_out_of_production_since": "2026-04-18T08:58:55.9251651+00:00",
"date_end_support": "2026-04-18T08:58:55.9251651+00:00",
"sales_organization_id": "07f1d3c1-0de7-460f-868a-4680a7795fc0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+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-04-18T08:58:55.940801+00:00"
},
"project_status_id": "5ab51fa9-fef1-4fb9-9733-f1c412f5ac80",
"project_status_code": "sample string 10",
"project_status": {
"id": "958cf572-b459-4df7-b014-c40402a7ee11",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "37600e62-8f6b-4366-b671-e618cf272117",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00"
},
"company_id": "388ff2f3-c81a-49f3-9570-28704f88ac0d",
"company_code": "sample string 12",
"db_address_id": "923f8f24-8e01-4f5b-b5c7-16c8b74d98b0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c4ea8851-f6bf-4c29-ba70-97e8050e6502",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "109d332e-1fb3-4cae-a77c-0a4183d4e56a",
"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-04-18T08:58:55.940801+00:00",
"date_create": "2026-04-18T08:58:55.940801+00:00",
"date_update": "2026-04-18T08:58:55.940801+00:00",
"updated_by_user_id": "c42d05f7-189b-4f8f-a489-97b5aeb0d053",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T08:58:55.940801+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-04-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T08:58:55.940801+00:00",
"date_last_job": "2026-04-18T08:58:55.940801+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T08:58:55.940801+00:00",
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00",
"is_mobile_installation": true
},
"job_type_id": "95d8a058-f0f4-47f5-aaf0-566d396500f4",
"job_type_code": "sample string 7",
"job_type": {
"id": "74fdfdc5-c8f3-4eed-b733-55cd82f71731",
"name": "sample string 2",
"sales_organization_id": "e6b4df9b-b9de-48a7-a076-1da9abe79f99",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00",
"code": "sample string 7"
},
"job_priority_id": "318b68a8-c6b0-4c69-9837-c87f348c0d51",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e0d4afbd-a69f-49f6-bbc8-dc8d4eb259fd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "296ec380-23d3-4a51-8bb1-5e8e86e74c78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00"
},
"job_status_id": "4055a94b-8b1e-4f2c-bf54-64323f8c334b",
"job_status_code": "sample string 11",
"db_address_id": "5ac38343-8430-4f90-af26-f8a77e9b6201",
"contact_id": "e7793ee4-79e2-4b98-b628-03dedd19e502",
"requested_by_company_id": "506abec1-ed38-4fb6-9172-dcaec754021b",
"requested_by_contact_id": "6d4ad29b-9cab-4a38-a123-26e9bc504f32",
"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-04-18T08:58:55.940801+00:00",
"due_date": "2026-04-18T08:58:55.940801+00:00",
"date_create": "2026-04-18T08:58:55.940801+00:00",
"date_update": "2026-04-18T08:58:55.940801+00:00",
"date_closed": "2026-04-18T08:58:55.940801+00:00",
"suggested_user_id": "3e1e4297-1081-4c87-9d60-96ffd0b50ba7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4c1ee29e-660c-4a2f-a7bc-4b41dea490b7",
"db_language_id": "7f8598fe-e73d-4452-ab91-0b242a3b355d",
"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-04-18T08:58:55.940801+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "899b6f64-c69c-404e-b1ea-9b53baa0320f",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e1661c96-2799-4f09-9c8d-91a8b04cd24a",
"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": "451aeb5c-64fb-4d55-9a30-b1a8df3bc4f7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "23efaa37-d20d-4f42-bed1-d2daadb62992"
},
"suggested_date_start": "2026-04-18T08:58:55.940801+00:00",
"skill_id": "942d780f-21a0-4bbd-abf8-d659fda8135e",
"skill_code": "sample string 32",
"skill": {
"id": "3759a0a9-5785-4fe8-8c20-ca1e1565dddf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "94479217-ea56-4b6a-b402-6232c5c8100a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "740f9b6d-dc08-4dae-b02f-11c23b1dc377",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84060efe-297b-4437-a53b-2ab789dde148",
"db_currency_id": "c60a655f-253f-4c41-9348-fa247b411a3a",
"db_language_id": "59229540-82e5-4cb3-890d-893780ea325c",
"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-04-18T08:58:55.9251651+00:00"
},
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "11c6343e-d8b0-4790-b61c-4cb396fb064c",
"date_reported_by_company": "2026-04-18T08:58:55.940801+00:00",
"id2": 36,
"company_id": "e9ef27db-e7c5-4cd2-bc49-0d43fb9e8d92",
"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": "18e6e4e5-2424-4d46-8ca2-c35f7267bcbe",
"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-04-18T08:58:55.940801+00:00"
},
"work_instruction_details_id": "3a460986-e826-4c86-a9b7-ad0d306f5e6d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "53114310-3677-4444-a195-c8d2f17bf4be",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a48a414c-73da-41f5-ba03-955ebeb1561d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T08:58:55.940801+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": "5de35f36-36da-44bb-8e2f-338a2d3f4e44",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T08:58:55.940801+00:00"
}