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": "4a4e4527-cb19-4281-9759-a4ee5a78d549",
"jobs_id": "5afa6c52-edb1-4643-87f3-c12965ba2217",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dd693fa2-de99-4e45-a79a-d9ad5899eda6",
"_parent_id": "3dd9f7a7-59e4-4eda-a100-a49f8fa38287",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "83b78d96-b806-4c8f-9b8e-37a7672f7ea0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2a77bc59-59db-4d2d-981e-80b4e5679da9",
"_parent_id": "594f3741-7ce9-417d-b67c-a5c35996d4db",
"root_parent_id": "d6aba8da-bcd9-474a-a488-3d7038875040",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e362d7c7-0dd7-4e6c-b70f-7c6ba1802623",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53e3bff3-1100-43c9-a6f8-773b0eacc573",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f45c7960-a1cd-465d-96dd-4500659590fa",
"_parent_code": "sample string 6",
"sales_organization_id": "f2893b52-dbce-468d-ace9-1251e0c2593b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"equipment_model_id": "6746d622-6916-4a8d-82ca-fc6b4b1ca45f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c70b5e31-2e73-4b9f-a7ee-d26eeadfd9fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "529a31ec-8e83-462b-8a20-9ee37281845c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d337893f-959e-4eea-977e-c6f9a202a6cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "988be47b-d05f-48c6-b291-566a0c83f728",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"equipment_family_id": "1d9dc00f-76c9-4639-9ba1-4acba81b7daf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53e3bff3-1100-43c9-a6f8-773b0eacc573",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f45c7960-a1cd-465d-96dd-4500659590fa",
"_parent_code": "sample string 6",
"sales_organization_id": "f2893b52-dbce-468d-ace9-1251e0c2593b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"date_in_production_since": "2025-11-17T00:48:50.8617308+00:00",
"date_out_of_production_since": "2025-11-17T00:48:50.8617308+00:00",
"date_end_support": "2025-11-17T00:48:50.8617308+00:00",
"sales_organization_id": "395b890d-d059-4be3-b30c-b16316cb607b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+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-17T00:48:50.8617308+00:00"
},
"project_status_id": "f1b22fa7-a40b-4cab-9cf3-9aa67df4ea22",
"project_status_code": "sample string 10",
"project_status": {
"id": "c7dac435-a8fa-44e1-8ab2-fb32d34b4fc8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "20661a3f-968e-4995-9154-f76c49ec5997",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"company_id": "8649d26f-07ac-432d-839c-d2d512825999",
"company_code": "sample string 12",
"db_address_id": "4ab4bb62-23f3-49bd-87bc-9e41ee6cf6bb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc86b4f6-e131-4b04-8c41-ce62ca5a80ea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "96b3bf95-e05f-4137-83f0-e5eaae400683",
"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-17T00:48:50.8617308+00:00",
"date_create": "2025-11-17T00:48:50.8617308+00:00",
"date_update": "2025-11-17T00:48:50.8617308+00:00",
"updated_by_user_id": "7d667ff1-0c5c-46aa-a383-ba02fe84ede7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T00:48:50.8617308+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T00:48:50.8617308+00:00",
"date_last_job": "2025-11-17T00:48:50.8617308+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T00:48:50.8617308+00:00",
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b9348f5-3795-4259-92c9-b35e37dcc7fd",
"job_type_code": "sample string 7",
"job_type": {
"id": "07e7db9f-b57c-4ac0-b8ab-fd0e9f543efb",
"name": "sample string 2",
"sales_organization_id": "afc3f3d0-9e76-42e9-a41d-63b96baab623",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00",
"code": "sample string 7"
},
"job_priority_id": "272f9fbd-867f-4f76-babc-7eeb7d6e750f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "140c1481-3a52-4e0e-a891-f474f9a1a0b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7d88e0fe-ac5b-46cb-9682-dc1132c17ec9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"job_status_id": "0f21d536-ea19-42a9-b5e3-b00eb6604ce0",
"job_status_code": "sample string 11",
"db_address_id": "00e15862-e628-4a02-aff8-c9ee9176904b",
"contact_id": "03445197-c06d-4f08-ba70-32231f85689c",
"requested_by_company_id": "5f9fcb2d-a3e3-4eba-94da-9e6d94999882",
"requested_by_contact_id": "50a05657-f414-4f76-b8f5-88f256728256",
"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-17T00:48:50.8617308+00:00",
"due_date": "2025-11-17T00:48:50.8617308+00:00",
"date_create": "2025-11-17T00:48:50.8617308+00:00",
"date_update": "2025-11-17T00:48:50.8617308+00:00",
"date_closed": "2025-11-17T00:48:50.8617308+00:00",
"suggested_user_id": "1bdcd3af-0965-4155-b8b1-cd0c4731dbf3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a461737b-6ced-4031-ba94-4f832250d143",
"db_language_id": "07ba0a9b-621f-47f2-80f8-784cf000cb00",
"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-17T00:48:50.8617308+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bac4736f-e5d7-4f6a-a140-cb0819f055df",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4b8ed8a9-9c97-4cca-bd34-146869c11bfc",
"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": "8c3b3085-e5d4-4e4f-9f3f-a707ebafeb19",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "56b7b78c-1f07-4862-9af2-483664f6f97c"
},
"suggested_date_start": "2025-11-17T00:48:50.8617308+00:00",
"skill_id": "09c045fc-ded1-4e35-b399-05efbc07b1c7",
"skill_code": "sample string 32",
"skill": {
"id": "12bef2bc-7b0f-4162-b4be-54a3a090dc49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8634c31c-dfc8-40ac-8d00-c61b3e10ed80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b05dafd-3164-4436-a374-f013c3022503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c5a325b-0503-4f43-bab1-ef8704c760c1",
"db_currency_id": "d5476441-1edc-4ed8-a15b-a87c3d44f611",
"db_language_id": "8971beb2-9293-4472-b1ca-0239f6446d16",
"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-17T00:48:50.8617308+00:00"
},
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "23c3b87c-9bdc-48c1-aabc-71ce787d863d",
"date_reported_by_company": "2025-11-17T00:48:50.8617308+00:00",
"id2": 36,
"company_id": "5eb5d907-9b19-4196-861a-f4bb74dfc7bd",
"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": "8d07e40a-8fed-4a35-8cd5-963328d2fd7d",
"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-17T00:48:50.8617308+00:00"
},
"work_instruction_details_id": "4af91b1a-4f70-47e2-8a4e-156574c6cce3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4f04677d-5933-4060-b501-da96c56bced8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2ef04fa9-dd0e-419f-a63a-a45ac66f33ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T00:48:50.8617308+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": "17e1ce91-fc4a-476e-9485-c1033fab9446",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T00:48:50.8617308+00:00"
}