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": "efa66f14-b0c4-472e-bc38-1559484e63b5",
"jobs_id": "f12c7578-1d0d-428d-b197-8e08e9814525",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "534d2afa-43c2-4ae7-a337-b9e93bb81739",
"_parent_id": "d8c3ef23-6b0f-42e6-b254-eb38c828a35f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ee32edad-e40d-43d8-8260-f8d7c57af85e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "09d15d09-c297-489e-a7e4-4ca50d1e25e2",
"_parent_id": "41042a99-b05d-4e08-80f8-ed6c2ac7ae8f",
"root_parent_id": "737d697a-78a1-4175-94dc-459df805dedf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fbd68322-fe42-4b34-8f57-dc6f274ebd2c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a6f17e75-371b-401f-9c5b-0bffc87bd55c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "699b0e78-dafc-4554-8c29-c1b3b41b8252",
"_parent_code": "sample string 6",
"sales_organization_id": "d19d9e45-8cea-4462-8709-73826c0035bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00"
},
"equipment_model_id": "2b24c3c7-6a91-4f31-bd93-147086bd4e37",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "de84f885-ae77-4838-a7ea-b384dd2df26a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "22fb92a7-992f-45d2-8a3d-426af3d58354",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e80ed287-aa9d-4c18-8e34-6117360f681f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09b79e25-52c3-4bb9-90ad-563be401c171",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00"
},
"equipment_family_id": "5c656649-96f5-42c9-a136-142eeb056cd5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a6f17e75-371b-401f-9c5b-0bffc87bd55c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "699b0e78-dafc-4554-8c29-c1b3b41b8252",
"_parent_code": "sample string 6",
"sales_organization_id": "d19d9e45-8cea-4462-8709-73826c0035bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00"
},
"date_in_production_since": "2026-03-01T11:04:09.9023778+00:00",
"date_out_of_production_since": "2026-03-01T11:04:09.9023778+00:00",
"date_end_support": "2026-03-01T11:04:09.9023778+00:00",
"sales_organization_id": "ff0a0337-d91d-4687-8a0b-836966673a70",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+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-03-01T11:04:09.9023778+00:00"
},
"project_status_id": "b22098d4-74d0-4d50-9bbe-b4d2510314df",
"project_status_code": "sample string 10",
"project_status": {
"id": "19800167-1e24-4842-a0b2-f2b9c2e4d061",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "126d0883-fe64-4aca-b66e-77597a35aeb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00"
},
"company_id": "855218e3-e08e-4d25-8a3d-3a5c41c2d266",
"company_code": "sample string 12",
"db_address_id": "12b592ce-c241-4c2f-892e-f7fa31c00fc8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "85df8ff8-f8a4-429d-81b5-243e4989ebbc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d37f30f1-da01-4445-adff-6d43d6e6c78d",
"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-03-01T11:04:09.9023778+00:00",
"date_create": "2026-03-01T11:04:09.9023778+00:00",
"date_update": "2026-03-01T11:04:09.9023778+00:00",
"updated_by_user_id": "2b10d17f-a668-4931-9b92-dd78abc0f0ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-01T11:04:09.9023778+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-03-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-01T11:04:09.9023778+00:00",
"date_last_job": "2026-03-01T11:04:09.9023778+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-01T11:04:09.9023778+00:00",
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00",
"is_mobile_installation": true
},
"job_type_id": "7c223040-26ed-409d-811f-ad270e3a717b",
"job_type_code": "sample string 7",
"job_type": {
"id": "16929b27-47ff-4e6b-a081-712ddc61637b",
"name": "sample string 2",
"sales_organization_id": "1551d63f-b18d-41c7-a6bd-47c46a1a4245",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00",
"code": "sample string 7"
},
"job_priority_id": "51692f9f-ecfb-4b2d-8058-98f07dc690ef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0da7a038-4444-425d-b9cf-768bec8d0466",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db553dff-92cd-43a1-a0a6-a7f06161eda0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00"
},
"job_status_id": "dd2fb540-02f2-4fda-8610-62f9e3ddc5e6",
"job_status_code": "sample string 11",
"db_address_id": "cdb67297-3acb-4e2f-9d02-a492ff6f0068",
"contact_id": "7e5d4127-899e-4c09-b75a-3e33e821ef5d",
"requested_by_company_id": "f84b72c9-1c7a-4455-9c3e-55464c60907a",
"requested_by_contact_id": "5627d3fd-c1f5-4c0d-b4f2-75e8aac16bf6",
"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-03-01T11:04:09.9023778+00:00",
"due_date": "2026-03-01T11:04:09.9023778+00:00",
"date_create": "2026-03-01T11:04:09.9023778+00:00",
"date_update": "2026-03-01T11:04:09.9023778+00:00",
"date_closed": "2026-03-01T11:04:09.9023778+00:00",
"suggested_user_id": "4cf83f47-9b57-4d18-919a-a7fdd5c0ffc0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "311a06c9-21a5-455b-9052-65a671e1faf9",
"db_language_id": "77b51559-3358-497f-ad04-f513050d40dd",
"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-03-01T11:04:09.9023778+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c66534e3-31cb-41bc-a588-41996f2a7663",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7b686096-99d7-41a1-8f97-4a527d0b33b9",
"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": "4bb29ffa-9912-4922-b38c-fb9577c506ed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-01T11:04:09.9023778+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c29fb53c-0207-4872-9f25-958094c8fd6c"
},
"suggested_date_start": "2026-03-01T11:04:09.9023778+00:00",
"skill_id": "941f1495-0de2-4071-b02d-4906ad6d6c63",
"skill_code": "sample string 32",
"skill": {
"id": "d2cca16c-13f3-4880-9607-ad67448f2223",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "31d0b0aa-488e-4bf2-be44-849b805e2dd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c29fd60-5e49-46bf-930f-5a29aba5197e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b983818d-29ea-4f10-9c4a-3c3815da3df0",
"db_currency_id": "51187043-fc95-4956-a731-258fdbc12d3b",
"db_language_id": "b64cf70e-0761-44b7-a663-430ad51993e5",
"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-03-01T11:04:09.8867503+00:00"
},
"modified_dateutc": "2026-03-01T11:04:09.9179995+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8f1299d5-8253-4a5d-8b21-667a83be1a35",
"date_reported_by_company": "2026-03-01T11:04:09.9179995+00:00",
"id2": 36,
"company_id": "433b2408-cbce-4f25-8742-9022c39d25a5",
"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": "af19a845-273a-47db-a88f-3377293419df",
"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-03-01T11:04:09.9179995+00:00"
},
"work_instruction_details_id": "9006c8fe-f50c-4c16-b8fc-1d4d3098670f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "154fbae4-8beb-402d-b93d-2a5a2c6b3346",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e70f6b9b-f85b-4037-b46a-a48a2b3cbd71",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-01T11:04:09.9179995+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": "143dc7fb-8c45-47a1-aa07-a69690689316",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-01T11:04:09.9179995+00:00"
}