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": "f19daacd-8257-4ad3-962d-27be03e64ab7",
"jobs_id": "3ff8848e-f9ab-439c-97e4-1dc811139194",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9f23adfb-1e6e-4e91-a9f8-55b28d6f2fa8",
"_parent_id": "0728e8cd-f2d3-46d1-8766-e8450799f13a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bba5f883-6b61-403a-894f-de4b79a01288",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26c38ab8-acbf-4532-8e66-8e3c77492806",
"_parent_id": "79b2b887-329b-4e39-acf5-9939bff91da2",
"root_parent_id": "3ce376ce-6777-4b0d-8503-70176a8113eb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "743109f2-133e-46b2-b788-25a72527348c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "39054215-e059-4d4c-91c2-f39c9b54c9db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46ed154b-8741-4d2a-90bf-6fdfbc5e487a",
"_parent_code": "sample string 6",
"sales_organization_id": "54a4e760-6376-4df1-91fb-302e076b72c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"equipment_model_id": "0f82bad5-5063-4535-b461-ee8721b230e2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e2df7bf4-d196-4d26-a458-c949307d4765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2e8871e8-f11e-45f1-b9a8-b0aec869418a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "978247c1-6ef4-43b4-a632-3b697e9ccb7a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0b1fa59-c1a1-464a-ac29-b320f3f9a631",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"equipment_family_id": "2645c0aa-5d8c-4d91-a4c0-433e6c6731fa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "39054215-e059-4d4c-91c2-f39c9b54c9db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46ed154b-8741-4d2a-90bf-6fdfbc5e487a",
"_parent_code": "sample string 6",
"sales_organization_id": "54a4e760-6376-4df1-91fb-302e076b72c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"date_in_production_since": "2025-09-17T06:22:40.4470814+00:00",
"date_out_of_production_since": "2025-09-17T06:22:40.4470814+00:00",
"date_end_support": "2025-09-17T06:22:40.4470814+00:00",
"sales_organization_id": "2f78c329-77dc-4b83-ad72-d896c36ed513",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+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-09-17T06:22:40.4470814+00:00"
},
"project_status_id": "5f8dd8ff-6801-4dbf-91fe-48c256f432ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "5bf09633-d212-4c05-bde5-9a85b2e83092",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b951250f-44de-4750-b1a1-e05f93c4de1f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"company_id": "96c99beb-3a6e-4ddb-b9a5-16b7eb831b87",
"company_code": "sample string 12",
"db_address_id": "83ade073-c908-42bb-b74e-1c12956166b5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "03e00f6b-6ff6-4256-afc0-a2ab88044c26",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "370e17f8-4d01-4510-95a2-ac2664ceacfc",
"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-09-17T06:22:40.4470814+00:00",
"date_create": "2025-09-17T06:22:40.4470814+00:00",
"date_update": "2025-09-17T06:22:40.4470814+00:00",
"updated_by_user_id": "2c288bd8-2dea-4a77-8acf-4779a98d64de",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-17T06:22:40.4470814+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-09-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-17T06:22:40.4470814+00:00",
"date_last_job": "2025-09-17T06:22:40.4470814+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-17T06:22:40.4470814+00:00",
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00",
"is_mobile_installation": true
},
"job_type_id": "2c54f818-5356-4d8f-a8ab-1f2f9da22dda",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cacfc99-4b38-49b6-96ae-8cb47643f54e",
"name": "sample string 2",
"sales_organization_id": "d956933b-6591-4b8a-86cb-bf5a472a067a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00",
"code": "sample string 7"
},
"job_priority_id": "9a7a87e4-1f3e-47fc-8874-38e0eef7b1da",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f93f106-4426-4cfe-a0ef-9b04874c15ae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8ef39dc3-73fb-43de-b76f-e2f3c57bac8b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"job_status_id": "3677e4f5-a506-4692-89b9-b3937625483c",
"job_status_code": "sample string 11",
"db_address_id": "8e374442-54fd-499a-ba2f-daa26403027a",
"contact_id": "495946da-d707-4937-b01c-bfaa021e76db",
"requested_by_company_id": "b36dd88d-38b8-4f9f-9beb-191e90f11a01",
"requested_by_contact_id": "c29d627d-ae21-4db7-8687-c9186833d209",
"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-09-17T06:22:40.4470814+00:00",
"due_date": "2025-09-17T06:22:40.4470814+00:00",
"date_create": "2025-09-17T06:22:40.4470814+00:00",
"date_update": "2025-09-17T06:22:40.4470814+00:00",
"date_closed": "2025-09-17T06:22:40.4470814+00:00",
"suggested_user_id": "7a1e1072-c3b7-4c58-81a4-1a686e21b699",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "07c3380f-b64a-48f6-a1c0-57d1f7102829",
"db_language_id": "c9952468-e168-41aa-87ac-ac2783ac1b98",
"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-09-17T06:22:40.4470814+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0495152-0ec7-43f2-b4cb-049093233614",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73a8afb0-1982-4f01-b317-ce8faf88067f",
"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": "c10a8959-3b15-487c-bc43-a8bfa426d522",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ab44e122-2085-4d48-83d7-5b482419f022"
},
"suggested_date_start": "2025-09-17T06:22:40.4470814+00:00",
"skill_id": "d73ffc97-e285-4173-86eb-2fae1501650a",
"skill_code": "sample string 32",
"skill": {
"id": "69672479-e82e-43e7-b0f0-d60e2d23f425",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "74e3964d-f74d-44bd-8c52-ca23999c95b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd537179-d189-49ac-ac64-f5efb1aa77e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "036f4b2b-42ec-45e0-87c7-d1241041e6f0",
"db_currency_id": "605af8e3-f0ad-46f5-815e-947180aec740",
"db_language_id": "2448c392-4889-4b31-bb09-43c02c4d942e",
"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-09-17T06:22:40.4470814+00:00"
},
"modified_dateutc": "2025-09-17T06:22:40.4470814+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4da75cd-1206-4e8e-941a-94f18f15075d",
"date_reported_by_company": "2025-09-17T06:22:40.4470814+00:00",
"id2": 36,
"company_id": "f1a6d9d7-d55b-4000-8528-308891d4f503",
"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": "4329a9ee-311d-40fa-b29e-16d3ea22c78a",
"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-09-17T06:22:40.4627015+00:00"
},
"work_instruction_details_id": "c9b6e9d4-3aec-4a41-9550-f41dd3a1cd48",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e95e97f1-11b8-4691-aaee-e9e783d6e785",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5ba934bf-4593-4505-ad55-3763c96a012b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-17T06:22:40.4627015+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": "3f5645bc-9790-45eb-be58-4e61152ca5b8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-17T06:22:40.4627015+00:00"
}