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": "0c57a707-31c1-4739-9e27-f32d48d94872",
"jobs_id": "53d97ed8-e1f4-4ef2-8de0-87f05c817200",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9bcd0b1e-74ea-4da6-9025-3dc0c6ce32e3",
"_parent_id": "a4c2a57d-dac0-420c-bcc7-19b4a5ba77e7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c98577d0-0850-4d55-9f53-e6e7eeb9e6f9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4b30fe0f-6e2f-427b-ae8d-850e38c1f91b",
"_parent_id": "3b8fe8e8-32aa-460d-9a4f-302e4767a1a6",
"root_parent_id": "020de192-fd35-44c1-b85b-7a31e0d36077",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "62644cab-05a6-486f-9c00-18ccd27328c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "504a0e42-3583-46bc-96c2-9c489a0169c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c0318ac-8315-46d3-a1b9-311f2ace3a67",
"_parent_code": "sample string 6",
"sales_organization_id": "4921ad27-0f9b-4a42-a78d-0bf77357890f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"modified_dateutc": "2025-12-10T08:22:16.3451079+00:00"
},
"equipment_model_id": "501b2b47-9d29-4735-b645-d9fd91ed2c47",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c983d5ce-77f6-42d3-8bff-8f573426fbd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7573ee29-a85f-490e-a646-2aef5ed67029",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0b845a2f-2472-4aec-a80f-087ec1a99893",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f434465f-bb6d-424d-b363-418c363e196d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"modified_dateutc": "2025-12-10T08:22:16.3451079+00:00"
},
"equipment_family_id": "8bab2bc1-610b-4de0-894c-41e5ab823f0d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "504a0e42-3583-46bc-96c2-9c489a0169c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c0318ac-8315-46d3-a1b9-311f2ace3a67",
"_parent_code": "sample string 6",
"sales_organization_id": "4921ad27-0f9b-4a42-a78d-0bf77357890f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"modified_dateutc": "2025-12-10T08:22:16.3451079+00:00"
},
"date_in_production_since": "2025-12-10T08:22:16.3451079+00:00",
"date_out_of_production_since": "2025-12-10T08:22:16.3451079+00:00",
"date_end_support": "2025-12-10T08:22:16.3451079+00:00",
"sales_organization_id": "49a57aef-b48e-459d-8e51-137fd4a0b962",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+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-10T08:22:16.360724+00:00"
},
"project_status_id": "05399cd5-d59c-4d36-9164-f1584a8f64ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "73f337e6-d134-44bb-a857-3a1648854469",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6bf39d6-f920-46dd-b7ad-4a50d8893bf6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00"
},
"company_id": "e18d6a13-8248-407c-9ccc-ea6ce7ee08da",
"company_code": "sample string 12",
"db_address_id": "cced6029-eae5-45c8-af7c-9e7ebbd475cc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1564f896-3be4-49ae-a66b-622118be42fe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ea8dc646-63b3-4abe-b052-5ba2c4851d7a",
"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-10T08:22:16.360724+00:00",
"date_create": "2025-12-10T08:22:16.360724+00:00",
"date_update": "2025-12-10T08:22:16.360724+00:00",
"updated_by_user_id": "8d1987f2-23dc-4724-88e1-b97c58aad42e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-10T08:22:16.360724+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-10T08:22:16.360724+00:00",
"date_last_job": "2025-12-10T08:22:16.360724+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-10T08:22:16.360724+00:00",
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00",
"is_mobile_installation": true
},
"job_type_id": "d465ef3a-eb35-430f-8413-d2a7f8e882d6",
"job_type_code": "sample string 7",
"job_type": {
"id": "0dcdd285-ee50-44da-b403-9557aa8a4a8a",
"name": "sample string 2",
"sales_organization_id": "c9bdf309-e98a-4bca-bfa9-f3308a583484",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00",
"code": "sample string 7"
},
"job_priority_id": "d783b6d2-1b69-4ef2-87c6-ce3e4044b672",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1d9f811c-f591-47ee-9e8f-6d73fe80d27d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dcdc0e86-96d7-47a7-b6f6-a46e7d5ecfeb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00"
},
"job_status_id": "a75984df-d261-4a80-b80e-0b0959a79baa",
"job_status_code": "sample string 11",
"db_address_id": "f69fd1f9-d5b7-4c72-8bb3-f294230f0f67",
"contact_id": "e52587de-1b71-4ae8-883c-2b5e2793e510",
"requested_by_company_id": "8835c367-1dd9-48a0-86db-76634c3fcd0b",
"requested_by_contact_id": "d05270d5-fef4-4206-a89d-6b7a1987224b",
"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-10T08:22:16.360724+00:00",
"due_date": "2025-12-10T08:22:16.360724+00:00",
"date_create": "2025-12-10T08:22:16.360724+00:00",
"date_update": "2025-12-10T08:22:16.360724+00:00",
"date_closed": "2025-12-10T08:22:16.360724+00:00",
"suggested_user_id": "4124b553-97cc-49b9-9350-2afecd519539",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9ea6eb07-bece-4880-b370-b899e1c4d991",
"db_language_id": "6fe66a6e-ffd3-480a-9303-a9966ec40e24",
"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-10T08:22:16.360724+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6cfdee65-1b72-441a-b546-3a9e8c670c78",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7db1a311-b22f-49f9-8fba-e3e041baedd7",
"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": "c1f3be9e-9af1-4b0b-8947-f88b0894c3ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a2b57f68-8e8a-4900-916d-0216eb88136a"
},
"suggested_date_start": "2025-12-10T08:22:16.360724+00:00",
"skill_id": "ac0e9afd-0adf-450e-9142-147b7697cfec",
"skill_code": "sample string 32",
"skill": {
"id": "d4744599-8592-4004-bd14-99628dc77dd5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eacd505e-e136-41a7-b267-e6afafe2f45e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b073efc0-5c74-4740-a7a6-feb77cacd0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b8afbc7-ba67-489e-86b5-68ffa8106350",
"db_currency_id": "4efaa374-e8a3-4eab-a2d7-aa841e4f52c0",
"db_language_id": "27909677-13d6-4d60-bf2c-af7934a7b485",
"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-10T08:22:16.3451079+00:00"
},
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "465f6ae1-3ac4-4194-a767-be999105c8df",
"date_reported_by_company": "2025-12-10T08:22:16.360724+00:00",
"id2": 36,
"company_id": "963c5c0c-955e-4518-b96b-c054739f5718",
"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": "e79d0932-b08c-4420-bbb2-8414cacd7cdf",
"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-10T08:22:16.360724+00:00"
},
"work_instruction_details_id": "d8332513-e2c8-42fe-9125-966b76af1d85",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9640d7e0-c99a-4020-8fb2-73b35fdbccf0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "18fb3a76-c031-497e-8cdc-4ae2feb1345b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-10T08:22:16.360724+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": "0db35724-8a59-45ef-97de-0bdb79c75535",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-10T08:22:16.360724+00:00"
}