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": "98a0369a-832b-4656-a70f-f8c3a9288bbb",
"jobs_id": "e13ea020-f258-488c-84c7-54e7098c1f8a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6ced0d9f-f8be-4f43-aac1-d4ad634b7f86",
"_parent_id": "bfe045eb-e3a9-43c2-b239-5eb3f63ea707",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3890a876-5b12-4a42-afd1-02c1df62f545",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b4bba35-1c76-4c69-9688-17e8f1d9354d",
"_parent_id": "05a1c610-b01e-487d-95ac-a3d0e7036c66",
"root_parent_id": "eebadfe3-95b7-4f90-ba78-cbcc3e99ace9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "30ada13a-b9a5-4822-b041-d6aa6ed6218f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ecc91bdf-a6ba-4f78-8dd6-8dba7993d87e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "766a0a61-0f87-4bea-bde7-99b4dba65e19",
"_parent_code": "sample string 6",
"sales_organization_id": "5bcc15ae-188f-47a7-8634-7228e79a66ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"modified_dateutc": "2025-07-18T23:22:44.1980923+00:00"
},
"equipment_model_id": "948e9227-b35d-43ff-aa92-98d2299a5b98",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a89e7903-b6ce-4006-b816-87258959064d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b1d4423a-7bef-43fd-8586-5d0479aa3bde",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "55f8934a-9925-4c34-a099-7cdfa5011366",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "12328ab8-8a96-445f-be4c-232598fb415b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"modified_dateutc": "2025-07-18T23:22:44.1980923+00:00"
},
"equipment_family_id": "f23e1e8e-cea2-4742-8192-45fc9be5048e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ecc91bdf-a6ba-4f78-8dd6-8dba7993d87e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "766a0a61-0f87-4bea-bde7-99b4dba65e19",
"_parent_code": "sample string 6",
"sales_organization_id": "5bcc15ae-188f-47a7-8634-7228e79a66ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"modified_dateutc": "2025-07-18T23:22:44.1980923+00:00"
},
"date_in_production_since": "2025-07-18T23:22:44.1980923+00:00",
"date_out_of_production_since": "2025-07-18T23:22:44.1980923+00:00",
"date_end_support": "2025-07-18T23:22:44.1980923+00:00",
"sales_organization_id": "d391cf06-ecb1-44fc-b370-75291285b9ca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+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-07-18T23:22:44.2137166+00:00"
},
"project_status_id": "3d90802a-2e67-4214-82df-9d8e267e8843",
"project_status_code": "sample string 10",
"project_status": {
"id": "0736f92c-ba53-4d34-998a-e4f517e6fb19",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b06cca7-1654-4314-b0a8-ff2d5f1189a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00"
},
"company_id": "f641b8a3-43b5-4619-b870-877f52303895",
"company_code": "sample string 12",
"db_address_id": "d9c3950f-1939-4c13-82f7-cadb42a30f66",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f485d52-3ebb-4ccc-b6ce-84eb093518f2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "18e8c8fb-66cc-4370-a3f3-6d93ef1b7120",
"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-07-18T23:22:44.2137166+00:00",
"date_create": "2025-07-18T23:22:44.2137166+00:00",
"date_update": "2025-07-18T23:22:44.2137166+00:00",
"updated_by_user_id": "c2e8b271-2d88-4339-bf4e-6a10de9060d7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-18T23:22:44.2137166+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-07-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-18T23:22:44.2137166+00:00",
"date_last_job": "2025-07-18T23:22:44.2137166+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-18T23:22:44.2137166+00:00",
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00",
"is_mobile_installation": true
},
"job_type_id": "28c8148c-4c3e-4791-93ea-deb6a0005eb2",
"job_type_code": "sample string 7",
"job_type": {
"id": "54a59ead-e280-4d42-a14e-40d217ba8b82",
"name": "sample string 2",
"sales_organization_id": "af42ef93-a76e-489a-a6fa-f7d6687a2a92",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00",
"code": "sample string 7"
},
"job_priority_id": "18cc077b-d987-44b4-ace7-2a2e67160272",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d5ad83e7-6fc5-4a63-aace-bc363bb6b28e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "52a1767a-e3c2-407d-a834-eb33cc820134",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00"
},
"job_status_id": "269eff5d-35ff-4ab6-9414-38f28d459c35",
"job_status_code": "sample string 11",
"db_address_id": "eaf243e5-70c2-45bd-bb00-ed3d8bc07c80",
"contact_id": "72d0e352-74c9-41d5-81c6-8c4a846e3d46",
"requested_by_company_id": "ae2edf8d-d200-491e-a6df-c9f164eea7af",
"requested_by_contact_id": "d9b5836d-26df-42a4-b802-d3f6a12b22c1",
"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-07-18T23:22:44.2137166+00:00",
"due_date": "2025-07-18T23:22:44.2137166+00:00",
"date_create": "2025-07-18T23:22:44.2137166+00:00",
"date_update": "2025-07-18T23:22:44.2137166+00:00",
"date_closed": "2025-07-18T23:22:44.2137166+00:00",
"suggested_user_id": "e08e74db-40fb-4312-ae0d-59262123ee2b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e5ab4fdc-c611-42f6-a627-9839591d7e72",
"db_language_id": "ded4bf6c-fcff-43a7-874a-d9ff121e5c79",
"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-07-18T23:22:44.2137166+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9e9d4007-8bbe-4122-aa1f-451b2e7d9f44",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c058dd90-535a-4c3a-9903-7f69fa04f1cc",
"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": "d9bdf331-d0af-4802-978c-c0ba04601c7a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d15f4c68-4556-4dce-a6db-3f0f33a3eacb"
},
"suggested_date_start": "2025-07-18T23:22:44.2137166+00:00",
"skill_id": "9ac7601c-0703-4d40-997a-3522dca4047d",
"skill_code": "sample string 32",
"skill": {
"id": "38a4e7e7-f1e4-420c-b1fe-49650d63f16b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2875f256-c766-42a2-b52c-27700ffc902f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b8a98e91-05d2-438c-930e-5d0f6595cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee84f8f5-621c-4937-a2db-ab69e7a15f4b",
"db_currency_id": "deec61f8-42a0-4404-971c-e533f07ac292",
"db_language_id": "f485ab86-01a5-4152-b03c-0e0dfc9cbbff",
"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-07-18T23:22:44.1980923+00:00"
},
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5b22c15d-5b12-4e82-82f8-875e3a88fb2b",
"date_reported_by_company": "2025-07-18T23:22:44.2137166+00:00",
"id2": 36,
"company_id": "52d3279c-8b3b-4b1a-85d7-edb9641c15b0",
"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": "d894ef8b-cb11-4de2-a78a-76fe4e1acdce",
"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-07-18T23:22:44.2137166+00:00"
},
"work_instruction_details_id": "e0bc4599-e84e-4930-9375-830598520ec5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9bd20819-5b17-4f43-be6c-94ae33256d3c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1fc2535c-d738-44ce-9f5b-42b92d2dfde3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-18T23:22:44.2137166+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": "b2846530-98be-4bf9-a85a-f817458109c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-18T23:22:44.2137166+00:00"
}