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": "e94aa3a5-fe66-4f63-a193-c158c0b5c6e4",
"jobs_id": "1722a7d9-881e-4ddf-8f75-c14c4622494b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "11e0e83f-cb52-4ff9-811c-a4c3c1749d98",
"_parent_id": "753f3690-3ead-489c-a444-c90f70ad7e6b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "29ce23cd-76cc-47ea-958f-027f55d5ac81",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aae1fd57-df32-41b1-b0a4-e72dd72a5720",
"_parent_id": "0c3c45d6-9e41-43cd-b78d-7fd85e60627e",
"root_parent_id": "163c9703-62be-490b-a25a-c45a172e3ccd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "87fef836-0f4c-45ea-80af-41264435cbc3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e630cb36-6664-461d-8810-c92ccaf2e04a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "54aa340d-c0d4-4e4d-b3c1-fd7895344e47",
"_parent_code": "sample string 6",
"sales_organization_id": "73b01efa-0593-4356-8ddb-26875f48b64f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00"
},
"equipment_model_id": "7a99f206-fc55-4416-a815-b14c323b6c5d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2f42ce8c-2720-426c-bc31-d38beb10a017",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5aa28657-79c5-40d1-b2b6-8ec4c84be0e1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "827f6b59-3556-406c-a04d-cceea869dcaa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4fb63baf-98f5-4e09-a37f-de3546840723",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00"
},
"equipment_family_id": "d2657392-82bc-4fd2-a9c2-54ea21b7f3c9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e630cb36-6664-461d-8810-c92ccaf2e04a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "54aa340d-c0d4-4e4d-b3c1-fd7895344e47",
"_parent_code": "sample string 6",
"sales_organization_id": "73b01efa-0593-4356-8ddb-26875f48b64f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00"
},
"date_in_production_since": "2026-02-09T06:48:55.8061457+00:00",
"date_out_of_production_since": "2026-02-09T06:48:55.8061457+00:00",
"date_end_support": "2026-02-09T06:48:55.8061457+00:00",
"sales_organization_id": "3ed7fd9b-7ed9-4554-b9ad-3e8bf88862ad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+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-09T06:48:55.8061457+00:00"
},
"project_status_id": "ab9e49f0-62b4-472b-84e2-3d2f815e49ec",
"project_status_code": "sample string 10",
"project_status": {
"id": "b6b43d90-055f-403d-9c5c-7c17b572e4e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "be135b58-b32a-4a9c-8dc3-f972588a2d1d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00"
},
"company_id": "c13bb55c-4013-420a-b2eb-7feeaf57ea65",
"company_code": "sample string 12",
"db_address_id": "0e3a6430-e783-4c14-a7ce-d764b6fd60b8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ddcf8077-0b7f-49f8-b3f1-373044dfef7e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "68b801e7-1043-45cd-8e6f-5c77fb83efb1",
"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-09T06:48:55.8061457+00:00",
"date_create": "2026-02-09T06:48:55.8061457+00:00",
"date_update": "2026-02-09T06:48:55.8061457+00:00",
"updated_by_user_id": "9e5e358e-257c-4d0f-8866-6f2cc8bf59b4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-09T06:48:55.8061457+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-09T06:48:55.8061457+00:00",
"date_last_job": "2026-02-09T06:48:55.8061457+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-09T06:48:55.8061457+00:00",
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00",
"is_mobile_installation": true
},
"job_type_id": "a3102fe3-3fde-49a3-8bfb-327770d1a7f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "a31445ba-a7a8-444f-8e56-479af4e187bc",
"name": "sample string 2",
"sales_organization_id": "51754352-b909-4327-9b6c-6881dad3f30c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00",
"code": "sample string 7"
},
"job_priority_id": "e20d9347-14a6-411d-8bc5-1a944b9d0d0a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "67e5450d-bfa0-4b36-83d6-3fb1b4a5234c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1d058f27-efcc-4016-963d-991259329664",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T06:48:55.8061457+00:00"
},
"job_status_id": "aade2af7-9457-4103-8a50-8775074059b1",
"job_status_code": "sample string 11",
"db_address_id": "ef4faab8-7c62-41a1-bcfd-36ac4818594d",
"contact_id": "beb37e89-c084-416e-9e56-3bafe957b643",
"requested_by_company_id": "94f154a7-b795-41df-850d-315e09aea878",
"requested_by_contact_id": "3196e793-cd47-4bb8-af66-4729e3036d88",
"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-09T06:48:55.8061457+00:00",
"due_date": "2026-02-09T06:48:55.8061457+00:00",
"date_create": "2026-02-09T06:48:55.8061457+00:00",
"date_update": "2026-02-09T06:48:55.8061457+00:00",
"date_closed": "2026-02-09T06:48:55.8061457+00:00",
"suggested_user_id": "fc894757-d4ab-4f29-826e-d1fce896a7d8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4f89d762-c94e-47b2-9216-1f0430b9194c",
"db_language_id": "ab5f6de8-9871-449c-84f7-b7fe40c8e354",
"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-09T06:48:55.8061457+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fbdadee9-e151-4223-81a7-5a0f54676171",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8108481f-5a10-4ab4-8722-59d2cced25a8",
"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": "80236efd-2eb0-401d-961c-8c027f2fee0e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-09T06:48:55.8217685+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f49bb11-0341-4921-819e-61e9b655b574"
},
"suggested_date_start": "2026-02-09T06:48:55.8217685+00:00",
"skill_id": "657c2776-dfa8-4650-9a8f-c59d79a7a9d3",
"skill_code": "sample string 32",
"skill": {
"id": "40ef104f-d7b3-42f9-9da1-b2e6f21a9052",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "560cd1c9-1406-461f-ac04-c1b996b20307",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f743907d-efe7-4160-9db7-9c7b430f4861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e408db3-3f5b-48e0-bc22-7b07a3d92aed",
"db_currency_id": "0b7d7d6c-0ec4-42b2-ba45-9ed7a409ba84",
"db_language_id": "10f6c143-ef8e-40c3-86db-e10676556ee2",
"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-09T06:48:55.8061457+00:00"
},
"modified_dateutc": "2026-02-09T06:48:55.8217685+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "49993db7-dd13-42a1-9788-e8d391f2dd27",
"date_reported_by_company": "2026-02-09T06:48:55.8217685+00:00",
"id2": 36,
"company_id": "2aa53e85-4ddf-4fbf-b5b9-6c443fc4d83b",
"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": "da00531c-ab14-451d-b3bb-fd64c506b273",
"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-09T06:48:55.8217685+00:00"
},
"work_instruction_details_id": "b2660be1-2dfd-4f09-a789-a9dc8bfbf4f7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87c88adf-c744-49f1-93db-96f6eb3485c0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "13a984d4-64e5-4382-afbf-065e7b13f734",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-09T06:48:55.8217685+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": "bfd87659-6ab8-4221-a5f2-a1fe40083426",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-09T06:48:55.8217685+00:00"
}