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": "715994c8-796d-46b7-b41e-def17e160918",
"jobs_id": "248ddae0-e2fb-40e9-a5a1-fc9d25f2a22d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "46a4b9db-9c67-4e90-ac7f-147a0f26c39a",
"_parent_id": "e017bcb4-aa95-4208-905a-f1f3a94c3489",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "53b2493b-cc65-43e9-967f-a65fd1f9ac1d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "af9afa83-a605-49a2-a471-0952c8d0b790",
"_parent_id": "46984b61-aa95-4456-923c-6b64b1c6bcfa",
"root_parent_id": "e0bf55a8-3930-43bb-a8fe-301488d709c1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dc1ecdf8-b6b1-4ba5-afba-c6e48654f4ee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d66a8245-1031-40ab-aa57-202dc8a29488",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb49cbf9-3a9b-4d21-8082-96c46d2355b1",
"_parent_code": "sample string 6",
"sales_organization_id": "f17720f7-6789-45c1-b6d1-3b64a74e6f31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"equipment_model_id": "5c281af5-e8fd-4b5f-ab9b-6be1c7c2707c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b24cd12-d6bf-4175-aad0-46b988003720",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6f02048d-1bf3-41af-96d9-c2a4ebd4d2b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e6656e05-ca89-46ce-aa46-93ffef8fc259",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "754e45c9-cbee-4361-9f70-82b139ba586d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"equipment_family_id": "42ed18bb-d6d7-4e05-bf27-5de1b9a7ccf5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d66a8245-1031-40ab-aa57-202dc8a29488",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb49cbf9-3a9b-4d21-8082-96c46d2355b1",
"_parent_code": "sample string 6",
"sales_organization_id": "f17720f7-6789-45c1-b6d1-3b64a74e6f31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"date_in_production_since": "2026-06-26T15:52:31.6749343+00:00",
"date_out_of_production_since": "2026-06-26T15:52:31.6749343+00:00",
"date_end_support": "2026-06-26T15:52:31.6749343+00:00",
"sales_organization_id": "dc4931c2-b3fa-415a-bd49-7e32182aba84",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+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-06-26T15:52:31.6749343+00:00"
},
"project_status_id": "13258d4b-9f73-4814-9a90-111a8631ee52",
"project_status_code": "sample string 10",
"project_status": {
"id": "72e820bb-7ea5-4b18-91be-0185d22d0529",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "637ae084-0eff-4fa0-a470-277c91f7df66",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"company_id": "b0125e44-b465-478f-ac49-8ab9c2a322ab",
"company_code": "sample string 12",
"db_address_id": "70656b99-4662-45d0-8d88-12eb48bc4518",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fa91ff29-3246-466e-958f-b776717b9745",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3cc0fae5-0f1a-454c-9da8-3092a7aa4c86",
"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-06-26T15:52:31.6749343+00:00",
"date_create": "2026-06-26T15:52:31.6749343+00:00",
"date_update": "2026-06-26T15:52:31.6749343+00:00",
"updated_by_user_id": "f05cb093-2d9a-4525-977e-85b94fa5f181",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-26T15:52:31.6749343+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-26T15:52:31.6749343+00:00",
"date_last_job": "2026-06-26T15:52:31.6749343+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-26T15:52:31.6749343+00:00",
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00",
"is_mobile_installation": true
},
"job_type_id": "6953f84a-17a0-4cab-be66-bd3cdd76b389",
"job_type_code": "sample string 7",
"job_type": {
"id": "22ee2ae1-18b3-4322-925d-d6c33027dd2c",
"name": "sample string 2",
"sales_organization_id": "b330c0e6-e4fb-400d-8e95-f22f522cde56",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00",
"code": "sample string 7"
},
"job_priority_id": "8379c421-38ba-4eb2-8780-e2030aee4d35",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "34bc27cd-943b-4e2e-aad5-6d1b1a93c380",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79acd337-b473-48e8-be4d-f06877b61dee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"job_status_id": "462eb721-b49f-4f4f-a50a-63f1e40e620b",
"job_status_code": "sample string 11",
"db_address_id": "6e0ae0af-4a7e-497b-b7e8-2586a210373b",
"contact_id": "91388b71-440f-471b-8cbb-b2169da8a5de",
"requested_by_company_id": "f2e19788-4ea6-43a6-b8d0-395aa10c0543",
"requested_by_contact_id": "55402173-3c33-47b1-b054-33f29c7f3a5d",
"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-06-26T15:52:31.6749343+00:00",
"due_date": "2026-06-26T15:52:31.6749343+00:00",
"date_create": "2026-06-26T15:52:31.6749343+00:00",
"date_update": "2026-06-26T15:52:31.6749343+00:00",
"date_closed": "2026-06-26T15:52:31.6749343+00:00",
"suggested_user_id": "de437fec-e34e-4675-8788-f568764a226a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9740e2ec-320d-41a5-ac7d-9d9b1b806d30",
"db_language_id": "53209eaf-152c-4b29-846b-cc9c1076c6cf",
"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-06-26T15:52:31.6749343+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3b341ba9-a6d7-44e1-9ad2-23c78b23cf2a",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "496d3532-cd40-4359-9fad-1c9a0205ba2c",
"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": "ed23508a-2343-47e1-be82-82156f81c28c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f2315bbd-003e-4c69-99bb-45fca3229734"
},
"suggested_date_start": "2026-06-26T15:52:31.6749343+00:00",
"skill_id": "49fd9ebf-24b9-4815-993e-9d22fbcdde76",
"skill_code": "sample string 32",
"skill": {
"id": "ce4d6b60-2a36-4b5f-81e1-734995a29874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "009ff49b-6435-4f19-9288-8791af6f66a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "473320c8-ee88-451c-93d9-11f887168788",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6870df9-0b50-414f-a64b-a6479df7f3e3",
"db_currency_id": "1a794aed-ad59-4676-961c-c1c4dc3f1201",
"db_language_id": "2d0f320f-ca35-4d94-83e2-ebbc44aa7d98",
"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-06-26T15:52:31.6749343+00:00"
},
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e2cfe1bd-82bc-47ca-8d5a-315e1475f75d",
"date_reported_by_company": "2026-06-26T15:52:31.6749343+00:00",
"id2": 36,
"company_id": "ce6ea16b-46c4-4f4d-b916-15513a085db1",
"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": "58c57398-ec96-496b-ba4b-3bd43cad765d",
"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-06-26T15:52:31.6749343+00:00"
},
"work_instruction_details_id": "4df25fc5-b22c-4e97-9a8b-9854b959c1f8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "97f31ad8-1e26-4c2b-9067-5284af37d816",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3fafe054-5405-43c1-9adc-84f881c4e2da",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-26T15:52:31.6749343+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": "599e2241-69eb-4997-9b1a-26d53a98806d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-26T15:52:31.6749343+00:00"
}