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": "b0439ee5-c84e-4610-9202-b03278607146",
"jobs_id": "0ea71442-67fa-41a0-89f4-396b84e98342",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "35f85504-289c-4070-b2e9-a23c18adb622",
"_parent_id": "c653b077-08a2-4067-923e-3de786fb8947",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7fe4fafe-bebd-47b2-b005-0c39ab91109f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b74a469-5ec3-418e-9422-2ba34064736c",
"_parent_id": "fa7ed84d-e2d8-442c-8ba9-1240272b2184",
"root_parent_id": "c6ade866-d515-4ef9-ba56-44dce7d05176",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c653c4a6-887c-4525-9acc-554c432a815e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06916e9f-1823-4959-a7dc-28d7a9c666ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "371b0d35-725f-4d6c-93e7-6850d78def0d",
"_parent_code": "sample string 6",
"sales_organization_id": "eed03b20-73e1-469f-9816-a0fcbc21775a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"equipment_model_id": "1fcebab1-2cf6-4ba2-8441-c4043f084c74",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "893833f4-03f9-4fcf-82aa-c35d2146dee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ae446e33-fc89-4006-b2c5-ed799aabfd24",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "609de921-8769-4edd-9d92-a44ce191faa9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d1b036ee-8c90-4045-bcef-d7b71ad08533",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"equipment_family_id": "fc3808f6-7bf3-4d7d-8b7c-1a28379819f7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06916e9f-1823-4959-a7dc-28d7a9c666ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "371b0d35-725f-4d6c-93e7-6850d78def0d",
"_parent_code": "sample string 6",
"sales_organization_id": "eed03b20-73e1-469f-9816-a0fcbc21775a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"date_in_production_since": "2026-09-17T02:39:41.4997445+00:00",
"date_out_of_production_since": "2026-09-17T02:39:41.4997445+00:00",
"date_end_support": "2026-09-17T02:39:41.4997445+00:00",
"sales_organization_id": "c6d54471-004e-400b-a03e-4011c2fda0b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+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-17T02:39:41.4997445+00:00"
},
"project_status_id": "c5fb0fb0-b341-44bf-a791-e570b03a9a3b",
"project_status_code": "sample string 10",
"project_status": {
"id": "1628309f-b0f4-4d90-9ddf-aa507269fd59",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "72e23e3a-b0dc-40e3-8cbd-36439446c1a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"company_id": "90281840-3cb9-44eb-a60a-d301c595d516",
"company_code": "sample string 12",
"db_address_id": "1f2e0b2a-890e-4cec-a269-3ac6b27e2aca",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a5066404-d6d1-46e6-bf33-db71e7a94881",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a6051e4a-de57-46a3-83bd-7b786373e6c5",
"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-17T02:39:41.4997445+00:00",
"date_create": "2026-09-17T02:39:41.4997445+00:00",
"date_update": "2026-09-17T02:39:41.4997445+00:00",
"updated_by_user_id": "e2cc9bed-b531-45a4-96d4-95bbe4d01f9a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-17T02:39:41.4997445+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-17T02:39:41.4997445+00:00",
"date_last_job": "2026-09-17T02:39:41.4997445+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-17T02:39:41.4997445+00:00",
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00",
"is_mobile_installation": true
},
"job_type_id": "a94eac31-0296-4a30-b5e1-3ef59b6b9cfc",
"job_type_code": "sample string 7",
"job_type": {
"id": "5c113c6b-9d53-4ef9-add6-f218546699ac",
"name": "sample string 2",
"sales_organization_id": "ba47612e-df00-4d83-b04b-41acf4a3d7b4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00",
"code": "sample string 7"
},
"job_priority_id": "5f8fd6f0-2d53-4b4a-968c-730ffc6eef41",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d0ca2472-2d95-4693-94df-b260bcc8bf21",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c97005c7-326b-4b58-bf8a-9146a8999240",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"job_status_id": "da378c2f-559f-4269-93f1-79c203763b7d",
"job_status_code": "sample string 11",
"db_address_id": "a4d17112-ca09-49b2-96d9-470932d170ac",
"contact_id": "9c710966-edae-486a-8e83-2c80aab33e63",
"requested_by_company_id": "3fdd0c92-a6e5-408a-9ca6-9ae713fc7981",
"requested_by_contact_id": "640ab380-ca5a-407b-86ba-ca3edb3b1e1e",
"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-17T02:39:41.4997445+00:00",
"due_date": "2026-09-17T02:39:41.4997445+00:00",
"date_create": "2026-09-17T02:39:41.4997445+00:00",
"date_update": "2026-09-17T02:39:41.4997445+00:00",
"date_closed": "2026-09-17T02:39:41.4997445+00:00",
"suggested_user_id": "77bfd375-9cac-4175-8ba3-953ee8e1f18e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f6eff7c8-5bb9-4d91-8d6a-091aaffad0f1",
"db_language_id": "7d77cd2d-1665-4cc0-8f70-9d1d2eb3eb2b",
"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-17T02:39:41.4997445+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4452fcbe-0366-4825-ab20-f26e3ced6812",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "69f505e3-239c-4bec-816b-d7ab1aa1719f",
"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": "a5aab14e-07d1-410a-995d-4b53168575fb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5df0c1e-b6dd-4bea-8c7e-8285d34f2e77"
},
"suggested_date_start": "2026-09-17T02:39:41.4997445+00:00",
"skill_id": "97835ecf-fa5d-4341-befe-8d74650ceaf6",
"skill_code": "sample string 32",
"skill": {
"id": "e23935af-297b-4e32-ae1c-3112042c22f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c792fa61-1e63-431d-b00a-2cb6f98578f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "10dc6b24-6051-4836-93ac-fb3f6a5ae158",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77bcaa6d-091c-4eb0-9b29-a294039af4af",
"db_currency_id": "3cd00ec4-73af-4337-b6a1-d722d268a4dc",
"db_language_id": "e29ec302-e7c5-4456-9c89-e689852f546d",
"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-17T02:39:41.4997445+00:00"
},
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5dc31656-ff1b-419a-9177-f5561be2ff8c",
"date_reported_by_company": "2026-09-17T02:39:41.4997445+00:00",
"id2": 36,
"company_id": "1d66a7b7-0cf4-4d82-a913-bfaec28e830f",
"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": "25e6401d-5cb8-4315-b3c6-41baccb3d91c",
"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-17T02:39:41.4997445+00:00"
},
"work_instruction_details_id": "9205b0ef-d461-462a-b150-645a59dcd735",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cd2168ab-20d2-40ed-b199-7b6209cfba4f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d258e04f-355b-4484-96af-0d304b2a4378",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-17T02:39:41.4997445+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": "dd49bc4b-5266-4c6a-910d-a0bfb59ad9eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-17T02:39:41.4997445+00:00"
}