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": "c10ba158-e65a-4279-979c-48d67e4c47eb",
"jobs_id": "19b437a4-c7a1-4ef2-8488-68fa3de2a3d0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2972957c-baba-4b28-9ee2-97bf5708bfce",
"_parent_id": "61a5bf64-5215-4287-9fa2-a650dce0ed40",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f91d9249-f532-4850-afac-20919fd8e99e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "37081b04-3535-4784-a5df-ebb59b3d6c4d",
"_parent_id": "1777f57b-31ef-488b-b009-736224b54112",
"root_parent_id": "839d3539-1eec-4c31-8d32-8f42221b9984",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dba08955-7442-4928-8f79-c7bca306e24e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6bd15422-c377-4431-bee1-37075668636d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43976962-525a-4806-a574-e22d03417eb6",
"_parent_code": "sample string 6",
"sales_organization_id": "a4f1c03e-203f-4f44-9b02-4226d09ee8bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"modified_dateutc": "2026-09-30T06:03:04.5706937+00:00"
},
"equipment_model_id": "929fb646-784e-464e-ae42-43c883a0f0fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3f09584-69a6-4b41-a611-003aec768581",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0642faf9-7b62-4224-827f-ae6bfc335981",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4b307d1-966e-4216-92d1-ebd9a28c154c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e98f599-18c8-4d3f-b468-3ca4b829775f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"modified_dateutc": "2026-09-30T06:03:04.5706937+00:00"
},
"equipment_family_id": "b94c0c17-31be-4508-a1b2-85ec50e11c42",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6bd15422-c377-4431-bee1-37075668636d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43976962-525a-4806-a574-e22d03417eb6",
"_parent_code": "sample string 6",
"sales_organization_id": "a4f1c03e-203f-4f44-9b02-4226d09ee8bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"modified_dateutc": "2026-09-30T06:03:04.5706937+00:00"
},
"date_in_production_since": "2026-09-30T06:03:04.5706937+00:00",
"date_out_of_production_since": "2026-09-30T06:03:04.5706937+00:00",
"date_end_support": "2026-09-30T06:03:04.5706937+00:00",
"sales_organization_id": "63163e1d-49b4-4159-b9e0-caa9a15c5084",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+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-09-30T06:03:04.586358+00:00"
},
"project_status_id": "bf2fcea1-bb55-4d52-ba57-0f2bd6fca4e3",
"project_status_code": "sample string 10",
"project_status": {
"id": "d59d92fc-6593-41fb-99f9-cd1a51485a1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4cc1bca0-2cf5-483d-ad56-417e534c2006",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T06:03:04.586358+00:00"
},
"company_id": "25b2e103-f052-4d84-a042-30b220eaeb90",
"company_code": "sample string 12",
"db_address_id": "51e8c93e-0058-4edf-8b0b-1ff0a63ef60c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "601a6704-480a-4c2f-a35c-c996ef1ff8f1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7033daae-0447-4cb5-a3b8-e716fc354a16",
"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-09-30T06:03:04.586358+00:00",
"date_create": "2026-09-30T06:03:04.586358+00:00",
"date_update": "2026-09-30T06:03:04.586358+00:00",
"updated_by_user_id": "587455a3-8872-46cb-9694-ff59df5fe5fc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T06:03:04.586358+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-09-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T06:03:04.586358+00:00",
"date_last_job": "2026-09-30T06:03:04.586358+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T06:03:04.6019458+00:00",
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00",
"is_mobile_installation": true
},
"job_type_id": "12784066-4bc2-4ab6-9dcd-e9ee87951c69",
"job_type_code": "sample string 7",
"job_type": {
"id": "a7a8800d-15d0-49db-97a4-1f9a2f220453",
"name": "sample string 2",
"sales_organization_id": "a9728dd7-7a7c-4727-9137-a9d58e935880",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00",
"code": "sample string 7"
},
"job_priority_id": "d1435bb5-eb82-4b83-9c4a-90251c1c2f78",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "669c825e-4ec2-4490-91fc-c7771a40fb49",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e3a4245f-dc83-437b-9ae0-3143de3e2c28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00"
},
"job_status_id": "997d89d6-15fc-40da-8e7b-b9f326abc323",
"job_status_code": "sample string 11",
"db_address_id": "c9feff36-94c3-4015-96ef-a5437a15c658",
"contact_id": "5b55a151-fd5d-4761-aeab-74a63763866c",
"requested_by_company_id": "b417784f-6338-4ba5-91ab-aa36e424b94d",
"requested_by_contact_id": "b22758b1-c086-47aa-bfdc-a50ceebf2fe1",
"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-09-30T06:03:04.6019458+00:00",
"due_date": "2026-09-30T06:03:04.6019458+00:00",
"date_create": "2026-09-30T06:03:04.6019458+00:00",
"date_update": "2026-09-30T06:03:04.6019458+00:00",
"date_closed": "2026-09-30T06:03:04.6019458+00:00",
"suggested_user_id": "157396de-241d-4e3d-b946-444909d5f24c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5e60d304-5c20-4671-946a-0353be0bd098",
"db_language_id": "bc18b810-622c-4f89-9720-3db51b941b43",
"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-09-30T06:03:04.6019458+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4819815d-359b-4755-b8d6-37963244fda2",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2db528fe-b507-4c82-a9dc-c9bc946c90b9",
"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": "27662b7b-06bf-4782-925b-1501b93d25f0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d8ef7687-6022-4c0c-af19-9bdec772e307"
},
"suggested_date_start": "2026-09-30T06:03:04.6019458+00:00",
"skill_id": "d11324b8-a54e-4fe2-bda7-663fe77f3e20",
"skill_code": "sample string 32",
"skill": {
"id": "6a97fe32-5cb6-4787-abfa-226ff3db3c1b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a3b7226f-a0d8-46ee-9530-cea2dc7ea235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af5146dc-ce60-4863-82a6-edb9dbaa92fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "06d55063-dd2c-4168-9bfe-6621777160a7",
"db_currency_id": "2b4a1c7b-4b42-400e-9ea7-62080cd42e53",
"db_language_id": "12fcabe4-2e5a-44e1-a37f-2886d2342941",
"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-09-30T06:03:04.5706937+00:00"
},
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4038bfb2-e1f1-4d27-9f04-e59e81443a01",
"date_reported_by_company": "2026-09-30T06:03:04.6019458+00:00",
"id2": 36,
"company_id": "91764830-889a-4d17-966d-3188fe79e79d",
"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": "db0fe143-2cce-4067-a439-f72c4b80c602",
"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-09-30T06:03:04.6019458+00:00"
},
"work_instruction_details_id": "ed42e324-6ffb-4a93-b5c0-ec093cd79e19",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0029c55b-a83a-4b43-929a-1cc9b173df40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "36711ffc-45c5-457d-9908-87427d496ede",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T06:03:04.6019458+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": "06fcc758-a779-4edc-a86a-74c3d88d5b97",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T06:03:04.6019458+00:00"
}