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": "3337f69d-8c4f-4fee-85ca-da309bad7c6a",
"jobs_id": "f472e381-98d4-4591-9cb1-6348287e0902",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e90c8f4d-5b64-4a01-b6b6-87182199f742",
"_parent_id": "66034b25-8e07-459e-859c-616c68005a51",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5a15c488-a29e-4104-8e18-55ecacafcb73",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3cabceae-d7fb-4f7b-991d-ad9351fcdb91",
"_parent_id": "6cbdfcdb-db80-460b-b11b-19d8f0d7c1b1",
"root_parent_id": "70dd2898-d1fb-4388-a5d9-71146f96a8b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1c347eed-6ad0-4e4a-8d07-aab291d0356c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4aadb0dd-a360-4d92-a91f-bf9a98fd5bfd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78abbc54-be92-4e4d-a1b5-76735e767bde",
"_parent_code": "sample string 6",
"sales_organization_id": "61da82b3-f4a6-4fa0-ad3c-d7b2a3ff58ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"equipment_model_id": "02f2c760-e0dc-44e3-80b3-5237acdc454f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2240ab73-9e90-4258-866a-5887ede2640d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "92434a23-3ccd-4499-83e2-b9cba182c38d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d9be7a61-1a65-41fa-a20a-a83d79cf8716",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9c1f6cce-d83f-40e5-8658-f160660a21f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"equipment_family_id": "51673e8d-9ba2-48f9-8d05-2afee193b979",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4aadb0dd-a360-4d92-a91f-bf9a98fd5bfd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78abbc54-be92-4e4d-a1b5-76735e767bde",
"_parent_code": "sample string 6",
"sales_organization_id": "61da82b3-f4a6-4fa0-ad3c-d7b2a3ff58ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"date_in_production_since": "2026-09-26T09:39:29.1530802+00:00",
"date_out_of_production_since": "2026-09-26T09:39:29.1530802+00:00",
"date_end_support": "2026-09-26T09:39:29.1530802+00:00",
"sales_organization_id": "01eb420c-7c83-4827-895d-78de40ea6d62",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+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-26T09:39:29.1530802+00:00"
},
"project_status_id": "3614d982-abc5-4695-ab47-6e0dc8686725",
"project_status_code": "sample string 10",
"project_status": {
"id": "94543c41-536e-4438-8bed-1cf2188b922e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "da58aa57-ee83-4af7-9de6-25a36dc3a115",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"company_id": "be1be1f9-a2cc-49f5-a5c2-b5f4b3aad41c",
"company_code": "sample string 12",
"db_address_id": "619602ee-b2a0-44d4-b6f6-e53883795ac2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a1d3be3a-d3a3-435c-a447-69ab952ae64e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "62107f64-742c-427d-a9aa-6151a7f88ac6",
"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-26T09:39:29.1530802+00:00",
"date_create": "2026-09-26T09:39:29.1530802+00:00",
"date_update": "2026-09-26T09:39:29.1530802+00:00",
"updated_by_user_id": "5b6f87aa-2ce4-47a8-8b69-dadded8a79ac",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-26T09:39:29.1530802+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-26T09:39:29.1530802+00:00",
"date_last_job": "2026-09-26T09:39:29.1530802+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-26T09:39:29.1530802+00:00",
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00",
"is_mobile_installation": true
},
"job_type_id": "0d65b857-cc07-4eb2-9fb3-c6ddfaf8dd49",
"job_type_code": "sample string 7",
"job_type": {
"id": "1327433a-7f70-4312-bd9f-e41d1d5459db",
"name": "sample string 2",
"sales_organization_id": "d5552177-eec4-4255-b128-7cc4edd529de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00",
"code": "sample string 7"
},
"job_priority_id": "a135346b-cd28-4267-8734-15e659632367",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "233a2613-9a28-4e51-8c34-54a6f6cc622c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "faee7a8b-e8df-4547-8451-c4f2f2e2f44b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"job_status_id": "370ffa61-7bd1-4a87-9236-4d69bf6026c0",
"job_status_code": "sample string 11",
"db_address_id": "f702669f-b792-4bc4-9886-98296f314a11",
"contact_id": "e7a6decd-d5cc-440e-8714-86767fb5faa0",
"requested_by_company_id": "b88d65fe-6065-4f55-b963-781d0a1c1737",
"requested_by_contact_id": "b91819ef-bb34-488c-9c5a-2e20c6c2fbbf",
"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-26T09:39:29.1530802+00:00",
"due_date": "2026-09-26T09:39:29.1530802+00:00",
"date_create": "2026-09-26T09:39:29.1530802+00:00",
"date_update": "2026-09-26T09:39:29.1530802+00:00",
"date_closed": "2026-09-26T09:39:29.1530802+00:00",
"suggested_user_id": "7673f83d-b511-4344-a086-2b7aeb1df2e1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "25ed4847-5d3a-48eb-b227-d12631e3b8ae",
"db_language_id": "4ccc9f5b-ad2f-4af6-a5b7-4e81ec904fa2",
"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-26T09:39:29.1530802+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "31a03a86-a4c5-4114-bf60-b1ae8891dd80",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9d743d6f-00fa-4c50-9635-5cbf6ee5edb2",
"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": "8f52f531-4b2d-4615-a822-2eaeec594c01",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ba681ca-6944-4a56-9c9e-e2aac119b240"
},
"suggested_date_start": "2026-09-26T09:39:29.1530802+00:00",
"skill_id": "cd6ab401-aaf2-41bc-9430-e42b254d382e",
"skill_code": "sample string 32",
"skill": {
"id": "29f3467f-b143-4d97-a3e8-8fe68acaa7bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4d5ab570-653c-42f1-8672-16d5c71ff697",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "273ee43f-9574-4e5e-b9ce-014eecbfaa50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdeca38e-8447-44c1-8fe6-1bbaf6951683",
"db_currency_id": "e9a643f1-29bd-4116-977e-ad59304bfcda",
"db_language_id": "0837f113-3201-401f-a051-55d1543b2fa8",
"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-26T09:39:29.1530802+00:00"
},
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4134a0c1-cbc5-4842-94e6-94ae11b4fed2",
"date_reported_by_company": "2026-09-26T09:39:29.1530802+00:00",
"id2": 36,
"company_id": "476568a6-d5ba-41f5-8dea-a3b6d3c70f27",
"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": "1d991fde-2b85-44b1-beea-c3923d480314",
"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-26T09:39:29.1530802+00:00"
},
"work_instruction_details_id": "bdb3f4cd-c06f-4c69-9d6b-3abd47d88a52",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95b8382d-1913-4be3-8167-7aeb18e19285",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "85a08ef6-aa95-4c7a-8ac0-fbc95d7c7ac9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-26T09:39:29.1530802+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": "c096c67d-86ce-45f0-8334-d79d7a9e02db",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-26T09:39:29.1530802+00:00"
}