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": "dcb5ae02-88fd-4554-909e-1aef648c1ae8",
"jobs_id": "d5053fe4-8531-43ed-a3e7-d7c46e92c64f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4c03103d-d511-4426-8348-8a8909c018fc",
"_parent_id": "914698b8-da69-46f9-87c2-4372f42759cd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "74fa9094-492b-4d3d-a4a0-f3c73dd27c63",
"project_reference_back_office": "sample string 5",
"project": {
"id": "56caf3ce-fb72-4d0d-864b-e4f5a998f3ab",
"_parent_id": "802e0aa0-8a87-472a-a309-6aff8e2fc26d",
"root_parent_id": "85154c39-80c3-410e-aee8-2b31058e6cce",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0b7e08d-4f95-46be-a875-41b28bf2b559",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9d4e8382-6f8e-4760-a675-072819a4adee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29db885a-30f6-4a7d-861d-18b3c9136823",
"_parent_code": "sample string 6",
"sales_organization_id": "f52d0c06-559a-4fcf-970b-d58165c323e9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"equipment_model_id": "5badc95a-490b-4f6f-8335-e9cc02606c97",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6c6e26d9-3e9a-443d-b7d9-655fc6ad2c21",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a202af39-4c12-4089-b059-326bdd915b24",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e9cce7c3-1424-493c-b757-a416eb9732e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8ca44913-1049-4162-99f8-909b21ff42b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"equipment_family_id": "c6b991ed-8ae1-4a15-9a96-a0b6238710bf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9d4e8382-6f8e-4760-a675-072819a4adee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29db885a-30f6-4a7d-861d-18b3c9136823",
"_parent_code": "sample string 6",
"sales_organization_id": "f52d0c06-559a-4fcf-970b-d58165c323e9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"date_in_production_since": "2025-11-04T13:29:27.9801967+00:00",
"date_out_of_production_since": "2025-11-04T13:29:27.9801967+00:00",
"date_end_support": "2025-11-04T13:29:27.9801967+00:00",
"sales_organization_id": "acd07c2a-8f49-4ceb-9e6a-3c1b6d97e90c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+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-04T13:29:27.9801967+00:00"
},
"project_status_id": "24cfada5-289a-4f83-9b63-3875ff10b6a3",
"project_status_code": "sample string 10",
"project_status": {
"id": "37331af4-e5d6-468b-8493-901ec83c4922",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d090ead7-5313-485e-91bb-b23586a8391a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"company_id": "966e610f-bb71-47bf-9196-86fa620ca238",
"company_code": "sample string 12",
"db_address_id": "fc243112-d86a-46ab-9223-e6346ce6001f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "57c0299a-2df8-4a8c-8262-feedaf70fd89",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "10a2a7f2-9877-41a9-8e73-b6e582efe848",
"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-04T13:29:27.9801967+00:00",
"date_create": "2025-11-04T13:29:27.9801967+00:00",
"date_update": "2025-11-04T13:29:27.9801967+00:00",
"updated_by_user_id": "a130dbf2-0a63-4da2-a7f2-197061f3773d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-04T13:29:27.9801967+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-04T13:29:27.9801967+00:00",
"date_last_job": "2025-11-04T13:29:27.9801967+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-04T13:29:27.9801967+00:00",
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00",
"is_mobile_installation": true
},
"job_type_id": "c958fcb5-67a2-4a44-b84d-17ece42cac7a",
"job_type_code": "sample string 7",
"job_type": {
"id": "14abbcce-6ca8-40ec-84d4-a9da37813d51",
"name": "sample string 2",
"sales_organization_id": "ec3e440d-62ff-42ec-bc31-429cefa15297",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00",
"code": "sample string 7"
},
"job_priority_id": "37b01414-bae4-4144-9d2a-5d54f2c5d977",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "36ec0188-5ed1-4083-910e-9d2e9ed97a55",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "88b1def3-31df-4855-88ff-9986a35c0e6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"job_status_id": "66aa594d-53c4-4adf-a963-87d23430ca75",
"job_status_code": "sample string 11",
"db_address_id": "fea92574-d20e-4f20-9239-e18df2eec186",
"contact_id": "4ac860bf-1457-449a-90da-44454a4f5ebe",
"requested_by_company_id": "ce72cf2a-a0df-4e43-81a0-a49a6dab2326",
"requested_by_contact_id": "baf8f6eb-dfa8-45a0-8a7f-c5d0f3306b1b",
"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-04T13:29:27.9801967+00:00",
"due_date": "2025-11-04T13:29:27.9801967+00:00",
"date_create": "2025-11-04T13:29:27.9801967+00:00",
"date_update": "2025-11-04T13:29:27.9801967+00:00",
"date_closed": "2025-11-04T13:29:27.9801967+00:00",
"suggested_user_id": "0c0d4b4f-cd7a-4f13-94ab-d3a8e7b25a08",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3838c8b5-4c5a-4363-8012-6744aa381d63",
"db_language_id": "5b26879a-b3bd-49e3-bf6d-9f8086ab1e0f",
"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-04T13:29:27.9801967+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9671b34a-ddac-4649-a877-297cefd0c888",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "33d30804-3855-41f3-aba1-ec1735c2f38d",
"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": "971c4bd6-167b-4c51-8be5-fa7dfc355af7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "91716272-d570-42c4-95e6-1a225b3ce1ed"
},
"suggested_date_start": "2025-11-04T13:29:27.9801967+00:00",
"skill_id": "294791c3-caef-47cd-bd1e-f02fa360e14f",
"skill_code": "sample string 32",
"skill": {
"id": "952bfbd0-c183-4e8d-80f7-095c26af79ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "274abc7d-f40a-4bbf-a29d-d272b68a962e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77c91910-0f70-4b2c-ba9d-257d506eca3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa61378-cec9-4602-92e9-49da751fee0a",
"db_currency_id": "beece5f0-d518-46e3-8c73-d6aff187cea3",
"db_language_id": "f85d6883-a44f-4843-818c-63cf435fc0dc",
"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-04T13:29:27.9801967+00:00"
},
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9d57ceba-54c3-43f4-beb9-5f48f550195f",
"date_reported_by_company": "2025-11-04T13:29:27.9801967+00:00",
"id2": 36,
"company_id": "4ce2daa7-329a-4b18-9114-fd1a219ac170",
"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": "2e2d20bc-bace-4215-b47a-f671185abad5",
"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-04T13:29:27.9801967+00:00"
},
"work_instruction_details_id": "fddcb485-2e36-41a5-94dc-d73b00be0ab7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "02fdf4d0-1d71-4f65-ac50-46b85427cb02",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "257d42e1-eead-4966-87d2-2eaceb3e3814",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-04T13:29:27.9801967+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": "49825883-cd25-4237-bf92-bbedefa8bfd5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-04T13:29:27.9801967+00:00"
}