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": "b1e5ec02-310b-42e5-a3a8-c913480683d1",
"jobs_id": "578433bb-c7ea-4b7b-b29e-3f6c21c16900",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6de4af53-806e-40e3-854b-df42aa48ec16",
"_parent_id": "c0a3a393-41be-438b-a252-ff3668054c9a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d220dbf2-b84a-400d-a2dd-f760de6c2fcc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "479cbe39-0b22-4e05-82c8-bf606011636e",
"_parent_id": "5ed7da68-2311-48dd-aecc-156445faf41f",
"root_parent_id": "ade0fa49-2177-4b51-bc69-12ce1581aa04",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dc73456c-598d-48d0-84cf-1c80fd3d192e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "742628e2-448d-4d89-9477-972a07fb7ee6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89265099-44c5-43d6-8e2d-62f0df9403f3",
"_parent_code": "sample string 6",
"sales_organization_id": "ce901303-61cd-44c6-973a-4b8c7b62bfb2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"equipment_model_id": "533dca82-baf0-493f-839f-70ebad604cc7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "035cc0df-50d6-4155-bdcf-155f4aa17446",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "356ee814-cadc-49a7-940d-023fcd2083c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "de3ade4e-7d9d-4296-8265-fc5218d64989",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6630c2cd-4784-4ec9-8393-7d1040aac43e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"equipment_family_id": "0bdc1c01-e356-44d8-999b-59db36f29b52",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "742628e2-448d-4d89-9477-972a07fb7ee6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89265099-44c5-43d6-8e2d-62f0df9403f3",
"_parent_code": "sample string 6",
"sales_organization_id": "ce901303-61cd-44c6-973a-4b8c7b62bfb2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"date_in_production_since": "2025-11-24T00:47:07.5583778+00:00",
"date_out_of_production_since": "2025-11-24T00:47:07.5583778+00:00",
"date_end_support": "2025-11-24T00:47:07.5583778+00:00",
"sales_organization_id": "74f3caff-bfcf-410a-a040-0a0768ba8c2b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+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": "2025-11-24T00:47:07.5583778+00:00"
},
"project_status_id": "afbc5559-3b1d-4cd6-bb60-1f08c83a1775",
"project_status_code": "sample string 10",
"project_status": {
"id": "ed12def4-e71f-4748-973c-4e862b70237e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3930580b-ccf7-4d1f-9dac-fdc722b4e2b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"company_id": "72f9acda-3652-4a57-af07-acc9d9f669fc",
"company_code": "sample string 12",
"db_address_id": "b3618b0d-af8e-494d-9822-46aa6a6096bd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "06a5c86c-24a0-4a32-8bc8-c36295cc3fea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "50acca1e-1eaa-4ab6-95ce-32087e5a0704",
"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": "2025-11-24T00:47:07.5583778+00:00",
"date_create": "2025-11-24T00:47:07.5583778+00:00",
"date_update": "2025-11-24T00:47:07.5583778+00:00",
"updated_by_user_id": "7cbd0970-62c2-4dae-8741-af05474aadd8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T00:47:07.5583778+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": "2025-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T00:47:07.5583778+00:00",
"date_last_job": "2025-11-24T00:47:07.5583778+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T00:47:07.5583778+00:00",
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00",
"is_mobile_installation": true
},
"job_type_id": "22b9d2a9-875d-418d-b101-0bb358db5b8a",
"job_type_code": "sample string 7",
"job_type": {
"id": "55eb146c-7c2b-47a6-8fc0-9cbe3a29e18e",
"name": "sample string 2",
"sales_organization_id": "79384e22-74ca-4859-b192-f6b53ceb73fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00",
"code": "sample string 7"
},
"job_priority_id": "07f680f1-6bb8-4af0-ac2b-b97c5b7d8eae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5db714cc-6ca7-4258-b087-b8fa1fb995d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bdb1d8a5-3bf6-41a4-9d87-d1780dea7609",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"job_status_id": "4cea79e7-a947-46d7-9af4-a4145bc8045d",
"job_status_code": "sample string 11",
"db_address_id": "01fd490e-28f4-4e3e-b68b-737b529e6001",
"contact_id": "2b19d305-7233-4e4d-8573-8acad6eaa01f",
"requested_by_company_id": "ced27e47-02f8-440b-964e-eef7c13dfc13",
"requested_by_contact_id": "201cc626-d5f7-41b9-bf1b-c55b844c343e",
"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": "2025-11-24T00:47:07.5583778+00:00",
"due_date": "2025-11-24T00:47:07.5583778+00:00",
"date_create": "2025-11-24T00:47:07.5583778+00:00",
"date_update": "2025-11-24T00:47:07.5583778+00:00",
"date_closed": "2025-11-24T00:47:07.5583778+00:00",
"suggested_user_id": "1f93ef26-34ee-4fb4-b580-a53a961317b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "efce64e0-8719-44fc-aa72-0e696bb314b5",
"db_language_id": "6ff11b03-1fac-4946-95a2-07e874f34ccc",
"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": "2025-11-24T00:47:07.5583778+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "53d7564b-2a5b-4281-986d-8eec380794b2",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "23d8a664-70d4-42ca-a795-0bc5d4f6c9a9",
"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": "1e70155a-88ff-4b29-be53-20a6f6774f88",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "475d79b8-007b-4800-ae2f-ed8b7279c32a"
},
"suggested_date_start": "2025-11-24T00:47:07.5583778+00:00",
"skill_id": "b4960a24-2648-497e-be83-5f7f8bc8e867",
"skill_code": "sample string 32",
"skill": {
"id": "698d211a-4c86-40c9-a847-09f2f622813e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6e1e0128-2bc4-42ca-8794-10e034e3cc2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d77a462-8306-441c-9041-e4bcc69088d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "196058bb-a01d-4625-ab47-dc67481168a0",
"db_currency_id": "a481bcd5-1574-4421-a176-31c39aa4b1a3",
"db_language_id": "c024644f-e526-4d85-9579-b17022137bd5",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "446702da-ea0b-4998-8dd6-8054d4b876a1",
"date_reported_by_company": "2025-11-24T00:47:07.5583778+00:00",
"id2": 36,
"company_id": "0a65121b-e5f3-49fa-b23d-f1d384f51581",
"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": "56dae4ba-2191-4c40-92b5-21cd8c8d50fe",
"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": "2025-11-24T00:47:07.5583778+00:00"
},
"work_instruction_details_id": "75bb5cfa-45a5-4c29-aeb1-562aa83afe94",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8d9ca908-8565-43bf-849b-d846fd3bfffe",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5f578592-1a3f-406c-951b-4d7eaa77d705",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T00:47:07.5583778+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": "2702d8c0-8428-4efb-85f7-b881fddd577b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T00:47:07.5583778+00:00"
}