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": "b1aef1c7-01ef-43f8-a573-2a9418ec5ad3",
"jobs_id": "c0ed19a9-9439-4f36-8e67-ee8786f4befc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2a6a8808-0d23-453a-acfd-b8a6fa075ddd",
"_parent_id": "4c7a7300-691d-4b96-8f4f-9df9548d4112",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "645f6105-dbef-48b8-973b-3c9fd6dc1650",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0b5537b7-c886-484e-a437-c2ba1ac306c9",
"_parent_id": "ab68725f-8229-4860-b75a-507e00427954",
"root_parent_id": "ec440513-a8b4-43a3-a4bc-e38c4c772c81",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0bc2ca56-7a07-448b-9894-6e7c8ac083f5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8b6b5e73-29f7-4b71-b001-c24ea9be423c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16f74d91-a644-4838-af1c-6cada19fab16",
"_parent_code": "sample string 6",
"sales_organization_id": "28d69174-eaf0-4c77-81af-2d683ff12768",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"equipment_model_id": "d17f6719-a04c-476a-ab7c-1b8ceea5cb61",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "934c0e24-34ea-4f37-b09e-a9ea53206354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "babffa82-25fd-469d-8982-54aed6f31251",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "74ff3733-4306-4774-996e-47a271485504",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d780622b-ab1d-46c3-90db-eaf713494938",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"equipment_family_id": "252c5780-543c-4579-946e-9f0e8e2237f2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8b6b5e73-29f7-4b71-b001-c24ea9be423c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "16f74d91-a644-4838-af1c-6cada19fab16",
"_parent_code": "sample string 6",
"sales_organization_id": "28d69174-eaf0-4c77-81af-2d683ff12768",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"date_in_production_since": "2026-06-06T06:42:45.9444915+00:00",
"date_out_of_production_since": "2026-06-06T06:42:45.9444915+00:00",
"date_end_support": "2026-06-06T06:42:45.9444915+00:00",
"sales_organization_id": "dce8f429-c8bf-4269-b1d0-b8fb9238c288",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+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-06T06:42:45.9444915+00:00"
},
"project_status_id": "a0782e79-cf28-4006-9428-bec84a4c9037",
"project_status_code": "sample string 10",
"project_status": {
"id": "248786da-4faa-4066-8b27-566baf9fd1d3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b39dd8fb-139c-4954-9322-e9a86639c33d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"company_id": "ba9194a7-f757-48e2-9604-4b5fc3e46d5d",
"company_code": "sample string 12",
"db_address_id": "be4e1af8-b62c-400a-84e1-428e5eec08cf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d404976f-8bf0-4c96-861e-8e918f0e19dc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "671e57d3-af6b-4276-acc9-56d36b47e8ee",
"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-06T06:42:45.9444915+00:00",
"date_create": "2026-06-06T06:42:45.9444915+00:00",
"date_update": "2026-06-06T06:42:45.9444915+00:00",
"updated_by_user_id": "30a0bf0e-6628-4f83-8aec-b62f1e7925f3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-06T06:42:45.9444915+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-06T06:42:45.9444915+00:00",
"date_last_job": "2026-06-06T06:42:45.9444915+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-06T06:42:45.9444915+00:00",
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00",
"is_mobile_installation": true
},
"job_type_id": "401a74df-9dbb-4855-ac38-671268305acb",
"job_type_code": "sample string 7",
"job_type": {
"id": "e3a2a921-3a52-4151-8a85-8b1018443501",
"name": "sample string 2",
"sales_organization_id": "cf6dcdc9-3da5-463f-a4a8-20d3a8f304ec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00",
"code": "sample string 7"
},
"job_priority_id": "c78fba6f-e200-463c-91e9-9de89533f22c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5fd81faa-7e01-41c4-bf80-c7c8783c2214",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c6eab5dd-6c7f-4e03-b420-ca60bb09e006",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"job_status_id": "e422dae9-6861-4f41-81cd-d41c99551e3b",
"job_status_code": "sample string 11",
"db_address_id": "3cc98619-87ee-48ca-91c5-6d549f4ffe94",
"contact_id": "72eac655-3e05-4684-9d04-d7791bff82cc",
"requested_by_company_id": "c4066396-6861-4c66-b044-b4717808ca42",
"requested_by_contact_id": "fb3594d9-df0c-4c55-af2f-6213af3264a7",
"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-06T06:42:45.9444915+00:00",
"due_date": "2026-06-06T06:42:45.9444915+00:00",
"date_create": "2026-06-06T06:42:45.9444915+00:00",
"date_update": "2026-06-06T06:42:45.9444915+00:00",
"date_closed": "2026-06-06T06:42:45.9444915+00:00",
"suggested_user_id": "e9ac5b3e-5017-4a03-bf93-4388b371edf4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "93513656-7bae-4603-a715-d8279125c194",
"db_language_id": "d7577661-6f2a-4548-abaa-61e37e1b5908",
"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-06T06:42:45.9444915+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2b8038a0-cdba-4309-825a-51805462770c",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "82913232-f59a-44ee-aa25-0e9a2a47345d",
"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": "56abc4ef-0e3b-40d4-bcd4-01d1730610a5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2570ec87-bc34-4c90-96a6-f6f94ef35a4f"
},
"suggested_date_start": "2026-06-06T06:42:45.9444915+00:00",
"skill_id": "d2ae5988-20db-40fb-bf69-0db35bd43a94",
"skill_code": "sample string 32",
"skill": {
"id": "51bd38d8-4f52-4b05-ad6c-19d368059c1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b6b9014a-88f9-4c93-8ab7-c7c10e30d071",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562bfda9-a63e-4cb9-8638-49fbc3602232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe2c606a-6e7b-4d27-a7c7-5f3d454b631f",
"db_currency_id": "3976f9d2-a65a-41ea-9cb9-2b996c137abf",
"db_language_id": "16d0e43c-f21c-4df2-b215-4b51d4622f53",
"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-06T06:42:45.9288682+00:00"
},
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0576521b-a356-4843-8e1c-183785252499",
"date_reported_by_company": "2026-06-06T06:42:45.9444915+00:00",
"id2": 36,
"company_id": "3bd106ab-c934-4ec0-8c85-0c828065f01b",
"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": "7c99dd78-b311-4d58-85b9-2a8c20096243",
"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-06T06:42:45.9444915+00:00"
},
"work_instruction_details_id": "806881a5-d145-4b03-b38c-79d083989018",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "14733050-8536-48ee-9550-622a36bb8a5b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4bfe0761-7689-4eff-833c-53c14f555853",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-06T06:42:45.9444915+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": "9d31c746-8890-45d0-ba09-c358ab248006",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-06T06:42:45.9444915+00:00"
}