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": "8979a9e6-d8f7-46d8-bef6-c76e82c20c61",
"jobs_id": "d0b25216-8628-4a45-adc5-fedb405fa2ed",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2966461f-ae2b-4f27-ac8c-facbde296e03",
"_parent_id": "46549c91-702b-43fe-a55b-92f892694ed3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1b654135-c25d-4b03-8abb-401408f135cc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "42f95075-979f-47e1-a23f-353e3ab2fead",
"_parent_id": "123c0489-1c1b-4e38-af4e-5d0edd5d3e85",
"root_parent_id": "7cb6323a-0800-4819-8d09-3f460637edbc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f2e20552-e772-428a-a8f6-683bda97642d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ff76f1b4-d45b-4585-9e50-0966f6866c06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afa8eeff-38b0-496c-b904-fac2d92e9f8c",
"_parent_code": "sample string 6",
"sales_organization_id": "0364b6e2-f2f2-460c-b789-fcd0560ba8a6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00"
},
"equipment_model_id": "d2120c3f-a05d-472f-a064-f0a6974b9ed9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1969d9a2-e466-4203-b20d-17bb9848182f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "06db289b-af6e-4f60-bac0-e6f0fbf175c0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "451c836c-cf81-4259-95cf-1499e6a4988b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7cd8b314-8d49-4da7-b20b-156b89fcbd1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00"
},
"equipment_family_id": "084c6f10-0275-42d4-9f6a-108011f5031c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ff76f1b4-d45b-4585-9e50-0966f6866c06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afa8eeff-38b0-496c-b904-fac2d92e9f8c",
"_parent_code": "sample string 6",
"sales_organization_id": "0364b6e2-f2f2-460c-b789-fcd0560ba8a6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00"
},
"date_in_production_since": "2026-01-29T04:02:20.6266534+00:00",
"date_out_of_production_since": "2026-01-29T04:02:20.6266534+00:00",
"date_end_support": "2026-01-29T04:02:20.6266534+00:00",
"sales_organization_id": "c31ab5b9-58f0-4372-a010-dc6f9e267463",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+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-01-29T04:02:20.6266534+00:00"
},
"project_status_id": "dd1a3548-6d7a-4002-9df0-479fbe14e2b5",
"project_status_code": "sample string 10",
"project_status": {
"id": "da86ee91-ee02-4190-9498-6a52c98946a5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "16ad60c0-f86c-4335-9341-392ac46e4323",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00"
},
"company_id": "20dabc93-2d36-4413-8464-6c05f08a2be5",
"company_code": "sample string 12",
"db_address_id": "aaba69aa-914f-4be0-bbf3-1585c4691754",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d417a6c7-7d33-45f1-a65d-32572a2b0619",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4748358c-310b-48fd-ae11-8383ad826639",
"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-01-29T04:02:20.6266534+00:00",
"date_create": "2026-01-29T04:02:20.6266534+00:00",
"date_update": "2026-01-29T04:02:20.6266534+00:00",
"updated_by_user_id": "a8f77d27-3a33-4591-9259-d97b36d75359",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T04:02:20.6266534+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-01-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T04:02:20.6266534+00:00",
"date_last_job": "2026-01-29T04:02:20.6266534+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T04:02:20.6266534+00:00",
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00",
"is_mobile_installation": true
},
"job_type_id": "90826160-4bf6-45d3-95ed-62b343ba0672",
"job_type_code": "sample string 7",
"job_type": {
"id": "2e07dd06-59a9-453b-a3b3-67fd02078c88",
"name": "sample string 2",
"sales_organization_id": "0fec60bb-38fc-4260-8d56-3e99f1b780e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00",
"code": "sample string 7"
},
"job_priority_id": "3551dc65-e4c1-4e46-a182-78e68d1a148e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f9ffb243-623a-4b57-9605-4e4a76601864",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c653137b-b7cf-42b7-9d2e-e178a8f40740",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T04:02:20.6266534+00:00"
},
"job_status_id": "099032b6-dd19-4429-bfee-d56fb7ac289a",
"job_status_code": "sample string 11",
"db_address_id": "9baeb039-942f-4c9a-bff1-6fb4980fea0f",
"contact_id": "3503209b-e37c-43af-8903-7a5069a8127f",
"requested_by_company_id": "3f96893e-9e88-4c5d-8481-8ecef5abe036",
"requested_by_contact_id": "d4d4a33e-12b0-4eaa-ac8c-61691f71c7d3",
"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-01-29T04:02:20.642274+00:00",
"due_date": "2026-01-29T04:02:20.642274+00:00",
"date_create": "2026-01-29T04:02:20.642274+00:00",
"date_update": "2026-01-29T04:02:20.642274+00:00",
"date_closed": "2026-01-29T04:02:20.642274+00:00",
"suggested_user_id": "ea8d7d39-9409-4b5c-849b-82e775b9b532",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "18368cd9-31a3-4c78-90dd-34cda13a8c34",
"db_language_id": "fc089c24-2727-43f5-bc9b-ab132cbf0a5e",
"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-01-29T04:02:20.642274+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e26f148-5179-4d45-94fb-9ee0e6d5c780",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a6956c89-26b3-4388-8415-a8668b7b9a91",
"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": "efa56a93-58c3-496e-8118-415674602447",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T04:02:20.642274+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "782b7c67-c0b8-411f-a59e-25816ee5c2a0"
},
"suggested_date_start": "2026-01-29T04:02:20.642274+00:00",
"skill_id": "8836c44b-51d9-4dec-bb93-f08f00202717",
"skill_code": "sample string 32",
"skill": {
"id": "1b58ec48-5437-4c15-b5fd-5cfc49fb1d62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0891ea59-dc31-4e61-b118-28eddf90dcd9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f03487f-d8da-4c83-b52d-e748691acff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c4bb694-0ba2-472f-b28c-221ca73dd275",
"db_currency_id": "c0241746-885b-4155-ade0-c35c6afe995f",
"db_language_id": "11d8fc71-ca28-486f-9194-dc273f7ea76f",
"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-01-29T04:02:20.6266534+00:00"
},
"modified_dateutc": "2026-01-29T04:02:20.642274+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b4d165f9-7730-4700-9417-4e197e6ba0e0",
"date_reported_by_company": "2026-01-29T04:02:20.642274+00:00",
"id2": 36,
"company_id": "c58fc926-7604-4ec1-b274-1eae923f3d49",
"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": "94e870ee-d791-4635-950f-8b29187327b2",
"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-01-29T04:02:20.642274+00:00"
},
"work_instruction_details_id": "ca3f6caa-2bbf-40ac-8cbf-961556bea0b6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cb8774f1-faa4-4824-ac96-b2c40c3ae655",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cf82532d-047a-4f86-83c4-9e200ac3a23c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T04:02:20.642274+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": "66f9abcc-c8a0-481d-b291-917a9601f011",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T04:02:20.642274+00:00"
}