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": "da90c040-f333-4f75-9c33-ca5512e366c5",
"jobs_id": "81b64593-39e3-4828-9b90-7d7cdd4f898d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7cf294e1-7f6e-44d6-b5c6-652e0a102315",
"_parent_id": "8728b301-8e18-4e1f-9a37-d4c7a048500b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0438442e-7562-49f3-9f36-b5d5775929f9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7391a388-49f6-4cb7-ad36-f8b5ce5b7403",
"_parent_id": "30d07e90-e329-4c56-9a89-292bfacf1507",
"root_parent_id": "23dc9f84-8ae3-4257-a3f8-21cdfdbeb638",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ff9cc15d-ed88-4cad-bff2-314e2be0a0b1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "96eff809-6342-470e-8149-43ab5b1cdd67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae033f9c-0338-48a9-9b97-89195494ceb1",
"_parent_code": "sample string 6",
"sales_organization_id": "4cde3275-138d-47eb-a411-52371d491c9a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00"
},
"equipment_model_id": "d1058b21-cd77-45e6-ba7a-ddb0b7ec6fb4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d458406c-b014-4175-aca6-5723f30efc53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f9d40340-dcd5-4c21-b046-26e900322f79",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "369ada27-e56d-4869-9f52-160e34404b5b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e63dda78-26c1-4ccb-b011-dd5103f41699",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00"
},
"equipment_family_id": "f670a49d-326b-4c07-bac8-3d969208f0e0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "96eff809-6342-470e-8149-43ab5b1cdd67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae033f9c-0338-48a9-9b97-89195494ceb1",
"_parent_code": "sample string 6",
"sales_organization_id": "4cde3275-138d-47eb-a411-52371d491c9a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00"
},
"date_in_production_since": "2026-04-08T22:25:25.4720069+00:00",
"date_out_of_production_since": "2026-04-08T22:25:25.4720069+00:00",
"date_end_support": "2026-04-08T22:25:25.4720069+00:00",
"sales_organization_id": "8e8a866c-3e82-42f1-b2a2-44bb0e7cb63e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+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-08T22:25:25.4720069+00:00"
},
"project_status_id": "af03ff6a-dd18-4c61-bf0c-2bbf180946a6",
"project_status_code": "sample string 10",
"project_status": {
"id": "58bec2ac-331f-4b11-b797-08ded0c2e96d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5a6f81c0-f29e-408e-8629-472b28e7f409",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00"
},
"company_id": "5f2098b2-a45c-430a-a505-46f6fa4f629a",
"company_code": "sample string 12",
"db_address_id": "74c2eab1-28bf-4703-b8cf-d4d0e952e485",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2d289fc4-21bb-4eb8-8ebe-2332081d20b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0c0c5903-023c-4e10-83a3-9a37cb97b538",
"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-08T22:25:25.4720069+00:00",
"date_create": "2026-04-08T22:25:25.4720069+00:00",
"date_update": "2026-04-08T22:25:25.4720069+00:00",
"updated_by_user_id": "23b609a2-38b8-472b-95a3-14cfb3f9886f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-08T22:25:25.4720069+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-08T22:25:25.4720069+00:00",
"date_last_job": "2026-04-08T22:25:25.4720069+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-08T22:25:25.4720069+00:00",
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00",
"is_mobile_installation": true
},
"job_type_id": "88769d8f-ab5d-449b-ab04-d9f6754659f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "721dc028-c3a4-43de-8e01-c601cf53c23e",
"name": "sample string 2",
"sales_organization_id": "e900af6a-7db0-480b-be9d-c22153ce19f4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00",
"code": "sample string 7"
},
"job_priority_id": "70f12690-43d1-4872-8bfb-db0f45536ffd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b9ffcd08-1083-4706-8de5-bacb950319ab",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9990bb32-636a-44d0-a745-0cd8111ab0ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T22:25:25.4720069+00:00"
},
"job_status_id": "8c2bf67c-7085-4806-bc9f-98ce65ea8fbd",
"job_status_code": "sample string 11",
"db_address_id": "4f7137e4-dd07-48ff-8005-74d1cc4cf3b8",
"contact_id": "749b307b-5593-411f-9203-593ed73afa3f",
"requested_by_company_id": "165c51f1-dc0c-40c0-b2f2-11e251d1a4ff",
"requested_by_contact_id": "7b4aba6e-2370-47cc-81db-fc31eb08417c",
"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-08T22:25:25.4720069+00:00",
"due_date": "2026-04-08T22:25:25.4720069+00:00",
"date_create": "2026-04-08T22:25:25.487634+00:00",
"date_update": "2026-04-08T22:25:25.487634+00:00",
"date_closed": "2026-04-08T22:25:25.487634+00:00",
"suggested_user_id": "2590f6dd-38f2-4554-acae-073fdc047107",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e783775e-9e19-4ef4-927b-baa5d5b955b3",
"db_language_id": "1c4b2a41-a5f1-4de5-83e9-e80bdea9b4a6",
"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-08T22:25:25.487634+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2b7c2521-02d7-4dc0-b924-bfd87d54d5d5",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d5f3d2ce-fa82-4b52-80c5-b6f0ed3e22cc",
"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": "58459fb2-7782-44ad-9597-ce985d137fc3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-08T22:25:25.487634+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "16a428a5-8d79-4867-b51b-98852654d860"
},
"suggested_date_start": "2026-04-08T22:25:25.487634+00:00",
"skill_id": "cec48d87-4920-4d9c-94b0-163d1b345342",
"skill_code": "sample string 32",
"skill": {
"id": "92d035e4-cf17-4787-bb41-9a8a44ade5e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c027df42-3533-4bc5-9090-ed01c5a92a3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae33503a-257e-4287-8197-4978ea71fcca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1537a7da-b8ed-4fcd-889f-2e95326cc3b4",
"db_currency_id": "508792b4-0daf-49cd-9aa2-b747202c7f99",
"db_language_id": "2f518679-39ef-4aa2-a177-9c73cdacc3bc",
"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-08T22:25:25.4720069+00:00"
},
"modified_dateutc": "2026-04-08T22:25:25.487634+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c6888162-2f43-4b5c-b92f-95eb9165a539",
"date_reported_by_company": "2026-04-08T22:25:25.487634+00:00",
"id2": 36,
"company_id": "7a3e226c-90a3-4ab9-8780-6ef6437ab7ac",
"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": "12d2cf6d-4410-4d48-9c8f-5e6c7040deb0",
"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-08T22:25:25.487634+00:00"
},
"work_instruction_details_id": "ecf7a394-2d48-41a8-939b-b056535b9eaf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d7112276-803b-4b35-b1f5-208348239bad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "06e2ece7-dccc-4e9e-a810-ac1df9a0adb1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-08T22:25:25.487634+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": "f265d7f3-7788-404d-9922-0a1b1e32cf71",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-08T22:25:25.487634+00:00"
}