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": "a2119aa5-677c-4a76-b0b7-beeb6e75d591",
"jobs_id": "03458e4f-ff41-4e09-9f62-cfaa84ed0cc1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "139015ba-f82a-4be6-a3b9-ca1827693d08",
"_parent_id": "65648630-8f79-49a3-94cd-d29978ebcbe7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cd0a55c7-1614-4226-9723-f0ca420d814b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "89e8fd37-aa8c-4279-9e1d-42b7374b8797",
"_parent_id": "0541c1be-4545-40e7-91eb-91544faa88c7",
"root_parent_id": "50a71511-2281-44bf-87f2-bb261ed3dd07",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cac3fb0a-8bbe-49e5-9f5f-91aebd2db3bb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cd4dadd2-a346-4271-9648-e4fa691fff78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cc004eb-1f89-4489-bb5c-b07f39b75c30",
"_parent_code": "sample string 6",
"sales_organization_id": "f5997e5a-2912-4ef0-b7dd-b3aebbf6b819",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"equipment_model_id": "30d1a23a-497b-4478-a314-d2ed8861b5a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "39e29b0b-1b46-4bd7-be98-608fdae40c59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d5daa13-5170-4a48-8bf7-a6e429db8a4a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "826fc096-33a2-441b-a116-b333c57834f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "38e47b4b-ef01-4d28-baf8-c476b1c7957c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"equipment_family_id": "c23b50f0-2362-4841-9bda-ff6765d175c7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cd4dadd2-a346-4271-9648-e4fa691fff78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cc004eb-1f89-4489-bb5c-b07f39b75c30",
"_parent_code": "sample string 6",
"sales_organization_id": "f5997e5a-2912-4ef0-b7dd-b3aebbf6b819",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"date_in_production_since": "2026-09-18T02:41:06.5039382+00:00",
"date_out_of_production_since": "2026-09-18T02:41:06.5039382+00:00",
"date_end_support": "2026-09-18T02:41:06.5039382+00:00",
"sales_organization_id": "2d02450f-0753-4cf2-8540-e39f00c5f5b3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+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-18T02:41:06.5039382+00:00"
},
"project_status_id": "8e5dd394-c4a7-4bdb-807b-fc0a6c124a91",
"project_status_code": "sample string 10",
"project_status": {
"id": "5eb4e634-59bf-44b6-8eb6-71e9f9bb0871",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "608260fe-51e7-44d1-a4f5-06abb816f2e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"company_id": "c1819408-cd5e-48cf-8607-17e8fafcaa27",
"company_code": "sample string 12",
"db_address_id": "770acc54-c353-4fe1-a0af-30a3df889e24",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82cfd5e7-f05f-4c89-a438-e2ad01731112",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3bc59fe5-f225-46c0-bc47-476ad234ddee",
"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-18T02:41:06.5039382+00:00",
"date_create": "2026-09-18T02:41:06.5039382+00:00",
"date_update": "2026-09-18T02:41:06.5039382+00:00",
"updated_by_user_id": "a3818a7a-1223-40dc-9ebb-c406b926cc7e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T02:41:06.5039382+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T02:41:06.5039382+00:00",
"date_last_job": "2026-09-18T02:41:06.5039382+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T02:41:06.5039382+00:00",
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00",
"is_mobile_installation": true
},
"job_type_id": "d893548f-baa7-448f-adf6-5957bbfd96d2",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e9fab65-dc76-42a7-bb62-60012e1f3ecc",
"name": "sample string 2",
"sales_organization_id": "0080b618-5ea6-4861-b8a3-95047e425543",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00",
"code": "sample string 7"
},
"job_priority_id": "88dc2404-4caf-4f46-a05a-0bcf28266684",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "831c3d90-59c7-47e2-886e-beace015b008",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c3f3c5e-e224-47ee-a70e-a3e12d89bf0d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"job_status_id": "5fde4f31-bca9-41cc-8fe4-a2d1ef7e53f9",
"job_status_code": "sample string 11",
"db_address_id": "41d61081-7e06-4968-b39e-e2b560eded61",
"contact_id": "691b4377-a76c-4958-ad26-e119065a7f74",
"requested_by_company_id": "d6f7f638-54d3-42d7-9c63-2c018b62a9e9",
"requested_by_contact_id": "8e7c8e3f-5755-4cf7-9a55-c9417bba2ca6",
"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-18T02:41:06.5039382+00:00",
"due_date": "2026-09-18T02:41:06.5039382+00:00",
"date_create": "2026-09-18T02:41:06.5039382+00:00",
"date_update": "2026-09-18T02:41:06.5039382+00:00",
"date_closed": "2026-09-18T02:41:06.5039382+00:00",
"suggested_user_id": "01c95cbf-638b-459b-a4fe-bb32e9fd5f4c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3da8f540-1d94-458e-ba73-f235b2f4a131",
"db_language_id": "6b4bc068-5392-4a13-8638-682c7a5caee0",
"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-18T02:41:06.5039382+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c854f2cf-74b3-4a1e-a341-6a838d75507f",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "527c5c85-7aa3-4053-8e09-f2e3bc63456d",
"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": "9f070aba-22d2-426d-8bb8-df84fe440b55",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "34b88781-5aa1-4182-ad58-f9ff64127c33"
},
"suggested_date_start": "2026-09-18T02:41:06.5039382+00:00",
"skill_id": "ed9798a1-e013-4e03-b18d-25fcc2aa7c96",
"skill_code": "sample string 32",
"skill": {
"id": "49075210-acfb-4815-a0a8-d3ca89ab0975",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f12332f8-d40b-48a5-b25a-64369a0187ca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74f26e93-cf6d-43ad-90f7-2550c725477e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d3c15d-d4c2-4c84-8c6b-8d3eb24b1ec3",
"db_currency_id": "c184ef5c-4afc-461d-a5ce-b1fe5c4c2639",
"db_language_id": "61e17806-7019-4014-9a19-b58ab309a7fe",
"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-18T02:41:06.5039382+00:00"
},
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a4e66dd1-33d5-47e1-96ae-058c33c9e9b2",
"date_reported_by_company": "2026-09-18T02:41:06.5039382+00:00",
"id2": 36,
"company_id": "2ce36212-f320-47ac-abfd-997f29687b32",
"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": "5dc28dfa-1941-497f-a665-241a24285440",
"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-18T02:41:06.5039382+00:00"
},
"work_instruction_details_id": "4cd58e95-42fb-4208-92d7-624dee7b6c00",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "39ba8e9e-d847-4f3f-b764-b3512504d680",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dcd48e6b-0fb3-45e7-8fd9-570513fd5e77",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T02:41:06.5039382+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": "76cc767e-bcb1-433e-bc70-5464dea5800a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T02:41:06.5039382+00:00"
}