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": "12ac1e6b-e1fb-443f-8c74-6fa94a90f43a",
"jobs_id": "37a34fe3-39b3-4350-96bb-9ec917214230",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e834930b-a54c-41d6-b78e-b4eed00e651c",
"_parent_id": "4cd4b2b9-205e-4470-b2c9-3c47805ae0ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d97c42a0-9f80-4a2b-bfb7-b69e5efdd810",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5eb594a8-6763-4e00-b023-87ec6e204525",
"_parent_id": "9828f73b-0892-46c4-8c83-79a99289bd88",
"root_parent_id": "57540115-3367-4a90-bd89-29f4fafac439",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "defcf77f-bc06-4e14-8d1e-5fcdd23701d5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d4b3d9c6-21a3-4027-abcf-7873fff5a207",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13358459-6715-4fde-a1f4-a50fc31dbefe",
"_parent_code": "sample string 6",
"sales_organization_id": "773ae1cc-0b71-4cf9-b270-b52c4e7db490",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"modified_dateutc": "2025-12-16T16:49:28.7186667+00:00"
},
"equipment_model_id": "cfecf987-8ef4-439a-8ce7-904ad53886f1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea24105f-1cd3-47d3-bb2d-f33828de483e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "71bb1ae4-d10c-4afa-80bc-a81335ff477a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8f2a13dd-a035-4f0c-ab53-420338795ae1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0be287fc-74f7-4268-82b8-4026ca1fefc6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"modified_dateutc": "2025-12-16T16:49:28.7186667+00:00"
},
"equipment_family_id": "822b00e0-dcdd-4ea1-ab59-a8330ca0d653",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d4b3d9c6-21a3-4027-abcf-7873fff5a207",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13358459-6715-4fde-a1f4-a50fc31dbefe",
"_parent_code": "sample string 6",
"sales_organization_id": "773ae1cc-0b71-4cf9-b270-b52c4e7db490",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"modified_dateutc": "2025-12-16T16:49:28.7186667+00:00"
},
"date_in_production_since": "2025-12-16T16:49:28.7186667+00:00",
"date_out_of_production_since": "2025-12-16T16:49:28.7186667+00:00",
"date_end_support": "2025-12-16T16:49:28.7186667+00:00",
"sales_organization_id": "e4d2e950-b3de-44a8-b245-cf78c3a11aa3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+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": "2025-12-16T16:49:28.7342746+00:00"
},
"project_status_id": "a3d4c1b0-1be5-4fc1-ae5f-75288d6f6d5c",
"project_status_code": "sample string 10",
"project_status": {
"id": "bd47a3c3-e791-4651-8618-dd2639dc2e24",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c3cc296e-d5c7-4a49-b188-f0e579ce1bd3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00"
},
"company_id": "21e0f1c5-71ec-4314-85fe-df3e30d37a09",
"company_code": "sample string 12",
"db_address_id": "10019215-91e7-461c-9c7a-bed17167cad0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b19e883-a7d5-40ee-b300-20c2a916900c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9e62eb07-29fc-49f3-b166-be9540894e4b",
"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": "2025-12-16T16:49:28.7342746+00:00",
"date_create": "2025-12-16T16:49:28.7342746+00:00",
"date_update": "2025-12-16T16:49:28.7342746+00:00",
"updated_by_user_id": "e1236214-66dd-4d45-904f-c748640c42dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-16T16:49:28.7342746+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": "2025-12-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-16T16:49:28.7342746+00:00",
"date_last_job": "2025-12-16T16:49:28.7342746+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-16T16:49:28.7342746+00:00",
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00",
"is_mobile_installation": true
},
"job_type_id": "6fdc274e-403f-4911-b644-3f1ad7262355",
"job_type_code": "sample string 7",
"job_type": {
"id": "6f23e1be-4a70-46ca-a9a1-4402592ec327",
"name": "sample string 2",
"sales_organization_id": "8d9f3714-9cde-4d97-8e44-bd5c982b70bc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00",
"code": "sample string 7"
},
"job_priority_id": "a777c4dc-4917-4396-890b-c8c82bf3853f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e0b4ba05-2570-4c30-8a81-90b99c3e533f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "50a5aba1-969f-4417-9d53-4514be888bbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00"
},
"job_status_id": "063648cc-d7a8-4368-a234-1d236a1e316c",
"job_status_code": "sample string 11",
"db_address_id": "65c0a02b-d6f6-4d65-86ae-ebae0066faac",
"contact_id": "f094a79c-0e1a-4943-b83c-ef4007fc5e2a",
"requested_by_company_id": "5c7c47bc-344c-4a9e-8460-70316330378c",
"requested_by_contact_id": "2d3de693-d714-4769-b2ed-980a4433b0d6",
"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": "2025-12-16T16:49:28.7342746+00:00",
"due_date": "2025-12-16T16:49:28.7342746+00:00",
"date_create": "2025-12-16T16:49:28.7342746+00:00",
"date_update": "2025-12-16T16:49:28.7342746+00:00",
"date_closed": "2025-12-16T16:49:28.7342746+00:00",
"suggested_user_id": "c2f1c353-1fdf-4e12-a0ec-a2ab28b2f38c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1ca8cede-15f8-44b3-8041-3499d9290512",
"db_language_id": "9d5038a4-9869-40c4-8b1d-505d3780e595",
"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": "2025-12-16T16:49:28.7342746+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8ae127aa-66ae-4086-bbe1-b6e79d67e7e4",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "55fcb8ac-036e-4bff-914e-f56ffefb0031",
"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": "d67b760e-42af-43f0-8a08-64f5f5460bd0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2184e5db-f799-4cc9-a276-87ed9636ad14"
},
"suggested_date_start": "2025-12-16T16:49:28.7342746+00:00",
"skill_id": "fd1bc9bf-568c-45ef-8c4d-61cdcbc187a1",
"skill_code": "sample string 32",
"skill": {
"id": "2ec64946-3190-4c18-a776-dddd8c76b08e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ea9cbc17-6ac4-430e-b15b-949d9399bba5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff888f50-cdb5-419f-a871-0a13cb52e63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b86fd53-81b0-41e2-82b1-f9c9e537dfa2",
"db_currency_id": "fff8b67f-e275-471f-b491-c3e54d53d871",
"db_language_id": "70c7a412-49d8-45db-8ff7-fa2547f41658",
"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": "2025-12-16T16:49:28.7186667+00:00"
},
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "01437b48-4705-44db-86aa-2f6a366658cb",
"date_reported_by_company": "2025-12-16T16:49:28.7342746+00:00",
"id2": 36,
"company_id": "15fe717a-cdfe-4910-980e-82ed15e6df7e",
"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": "d73df015-bbdb-4336-a070-ea7f19ca0bdf",
"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": "2025-12-16T16:49:28.7342746+00:00"
},
"work_instruction_details_id": "0b7a9fd6-ab8b-464a-8c75-b661ca0c88ee",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eb3d828d-f3a8-4753-a36c-cb5a54be5230",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f2cd472-3c7d-4a6a-b33f-2b29d283900f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-16T16:49:28.7342746+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": "f28ece15-a65c-4f41-bd03-32bf38bc18c6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-16T16:49:28.7342746+00:00"
}