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": "dcf16347-207e-4cb1-9eaa-da09e80c400f",
"jobs_id": "6bf831cc-a435-40e8-b0b3-ea0510eaa33c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f0bb4430-7e43-428e-b5a9-40510a0f699e",
"_parent_id": "f3c06378-a3a5-4b6d-8c6a-f354f9855118",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "72d1ddb8-e68c-4ec3-9d2d-1ff9df1dab1f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5ab7bb55-f32b-43f2-a91c-f291f7ad3fd1",
"_parent_id": "fd1aa5c6-0b3e-48dd-a65c-2aedcba3a83e",
"root_parent_id": "5b784cbd-18d5-4e9f-878a-92fe5207c0c7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c3516026-ca62-43fe-a923-1e4fbcf70861",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2c55bd7c-100b-472e-beb1-5f530b892ba0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "652058cc-a99b-4bb1-973b-2fd8f86835be",
"_parent_code": "sample string 6",
"sales_organization_id": "2e31dee0-df98-4c02-a31c-15f17255b13f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"modified_dateutc": "2026-02-19T08:56:52.5376911+00:00"
},
"equipment_model_id": "3ec778b2-e6ec-40df-b859-16bd800ca5b5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5d78a26c-5530-4fa8-bd00-1f93dd59c7b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a6c51292-caba-4c3e-926f-902e02b39a37",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c230158e-9acc-4d81-9de5-c5670c5b1168",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ddad57ee-f7c4-417b-979a-68f3a4e90379",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"modified_dateutc": "2026-02-19T08:56:52.5376911+00:00"
},
"equipment_family_id": "c1e2ea73-175c-4ab9-be37-ebf0dd98727c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2c55bd7c-100b-472e-beb1-5f530b892ba0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "652058cc-a99b-4bb1-973b-2fd8f86835be",
"_parent_code": "sample string 6",
"sales_organization_id": "2e31dee0-df98-4c02-a31c-15f17255b13f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"modified_dateutc": "2026-02-19T08:56:52.5376911+00:00"
},
"date_in_production_since": "2026-02-19T08:56:52.5376911+00:00",
"date_out_of_production_since": "2026-02-19T08:56:52.5376911+00:00",
"date_end_support": "2026-02-19T08:56:52.5376911+00:00",
"sales_organization_id": "2aaeba73-acc6-417f-a27c-2f823bb4111f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+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-02-19T08:56:52.5376911+00:00"
},
"project_status_id": "21e7430f-8981-444e-a7bf-f8ee23cb61f7",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a223f3e-0be8-471f-9332-a5fcc0d7c922",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "55446283-e9c4-46e6-83e0-491708a14abd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T08:56:52.5376911+00:00"
},
"company_id": "1015a18a-4a32-4fd4-92da-6cd9518811b7",
"company_code": "sample string 12",
"db_address_id": "03c9c9c1-8c25-458e-8893-48b7ff568172",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8e224c02-d30d-4906-aef3-7468f496b921",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8913a0c0-1068-4564-b392-d4d4f2a63647",
"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-02-19T08:56:52.5533136+00:00",
"date_create": "2026-02-19T08:56:52.5533136+00:00",
"date_update": "2026-02-19T08:56:52.5533136+00:00",
"updated_by_user_id": "1ad13462-b5f3-4e09-89f5-19575bef772e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-19T08:56:52.5533136+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-02-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-19T08:56:52.5533136+00:00",
"date_last_job": "2026-02-19T08:56:52.5533136+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-19T08:56:52.5533136+00:00",
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00",
"is_mobile_installation": true
},
"job_type_id": "e4e1293f-4afe-4846-8f0d-1ae076fce6bc",
"job_type_code": "sample string 7",
"job_type": {
"id": "8247c18f-180b-44f1-8f75-eec79091b340",
"name": "sample string 2",
"sales_organization_id": "32a28e43-1809-4ec1-bb4b-d84c33733cba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00",
"code": "sample string 7"
},
"job_priority_id": "4be939fa-87c7-4ced-adcb-45e59a3c66ba",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2da18777-e1a5-4f6e-92b9-ad678fb252af",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7f24965b-93f6-4f65-bde9-4f466542ee87",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00"
},
"job_status_id": "d4399225-c33d-416c-be3e-790a535a3c18",
"job_status_code": "sample string 11",
"db_address_id": "1365ce4f-4b2a-43f7-8edc-e2ac180d401b",
"contact_id": "935c6f73-144a-4743-be81-d06f103fee37",
"requested_by_company_id": "49208bbc-5c02-4ae2-acdc-7a2829413399",
"requested_by_contact_id": "3edba743-0233-45fd-8585-72b929ced84e",
"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-02-19T08:56:52.5533136+00:00",
"due_date": "2026-02-19T08:56:52.5533136+00:00",
"date_create": "2026-02-19T08:56:52.5533136+00:00",
"date_update": "2026-02-19T08:56:52.5533136+00:00",
"date_closed": "2026-02-19T08:56:52.5533136+00:00",
"suggested_user_id": "c6a18d0a-1bef-4710-899a-1ed721ed342e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "135814de-3d15-465e-8bcc-fb67acbd5b5c",
"db_language_id": "993ebbec-849b-4924-a9d2-62a6dbcd0e96",
"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-02-19T08:56:52.5533136+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c19544f-1eac-43cc-8406-a558f1fd4d5c",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3271e98a-042e-495e-a0a8-71ef076cdc61",
"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": "4846c36b-fdd7-444f-8225-8e10cd388d95",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c45cae42-9ad1-439d-bfc8-857cb14341ec"
},
"suggested_date_start": "2026-02-19T08:56:52.5533136+00:00",
"skill_id": "d4e0d19c-5e6b-4357-81f4-592f8b49c9c7",
"skill_code": "sample string 32",
"skill": {
"id": "ccadd7ed-216e-451f-a236-da073619a4f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e8b467d0-1347-48c5-85ab-f9a1d54bc07b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "815ff5de-81e2-4339-86c4-aae85c899cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2b0a219-380a-4b4b-8f05-f23aff2997b5",
"db_currency_id": "f8efd8d5-5d75-49f6-8eb7-c863c60f3f1b",
"db_language_id": "5448a18b-8dc1-4d7c-9a91-26b7802bd532",
"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-02-19T08:56:52.5376911+00:00"
},
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f0e19499-bcc5-4aaa-b077-fa86d25bb5ff",
"date_reported_by_company": "2026-02-19T08:56:52.5533136+00:00",
"id2": 36,
"company_id": "4495a02c-033c-44d9-9e19-7d3cf6cf32ba",
"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": "2cc31d70-ffe8-48f6-9017-e8b64b29656c",
"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-02-19T08:56:52.5533136+00:00"
},
"work_instruction_details_id": "e67f80ea-fccf-46df-a408-e777113a5bde",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d286c033-c529-487f-a752-080d8fa7aa11",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a42b76f2-ba48-4683-bbab-5f05ff541e76",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-19T08:56:52.5533136+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": "4af9e0c8-03fe-4809-992f-4a320abf7496",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-19T08:56:52.5533136+00:00"
}