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": "81ffc146-b5a4-4c2c-859a-db7af32c93e6",
"jobs_id": "7bf11205-fcd1-418f-b66c-d4755da3e990",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "52e2665a-14cb-489e-b84c-45f4720d9b8c",
"_parent_id": "b43acc8c-6ce9-4023-9816-d278575eab52",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e88f589c-3849-4c6b-9805-5efcb36315ef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a6ef8752-fe03-4397-9a06-b4d4f8d878d7",
"_parent_id": "214be3d3-9e04-4ad7-949e-05d779b28a80",
"root_parent_id": "9473486a-ef98-41c1-9308-d12bc0c6498b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e44d3ed3-b787-4f86-8e1d-7ff1ef64933f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4328043a-db89-4617-b146-1e3f08686f46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a3f34157-5536-4256-a91e-981c9a933bd9",
"_parent_code": "sample string 6",
"sales_organization_id": "fcb5b4bd-4381-458c-910e-8225ec6d2108",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"equipment_model_id": "c4a6e922-ed55-4808-8fef-b2e87a067a9a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "618acdef-94f1-4db5-99a5-4e4724b82bb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "32b1c2bd-8b4e-45d9-9414-a9587b8a9b65",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2ebeef59-9238-4ec7-a546-9025e945aa26",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c44264e7-0f9b-46d8-9a32-cd4f124c1ad0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"equipment_family_id": "0f0aa7e1-408d-49c2-9a1d-4a19ef7b4ff0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4328043a-db89-4617-b146-1e3f08686f46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a3f34157-5536-4256-a91e-981c9a933bd9",
"_parent_code": "sample string 6",
"sales_organization_id": "fcb5b4bd-4381-458c-910e-8225ec6d2108",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"date_in_production_since": "2025-10-22T12:06:22.1599288+00:00",
"date_out_of_production_since": "2025-10-22T12:06:22.1599288+00:00",
"date_end_support": "2025-10-22T12:06:22.1599288+00:00",
"sales_organization_id": "f3aef6e7-f04f-4462-93f7-340ed95fe0ce",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+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-10-22T12:06:22.1599288+00:00"
},
"project_status_id": "36b6097b-cd0a-41d2-93cb-26244a7fbb27",
"project_status_code": "sample string 10",
"project_status": {
"id": "e49f52dd-eea5-46be-9b9f-2b55949c0e9b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5bdf0923-082d-47b0-ae34-b177b4e17b9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"company_id": "01cb3fb3-84d2-41e9-8b7b-e3b10fa834e8",
"company_code": "sample string 12",
"db_address_id": "4e1ef448-4f45-485c-b541-0efc68bdbf1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6e1e007d-c796-4e86-9e6e-42eb32eb4d96",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "acf7437f-dc12-465f-a66c-ed587f5b9da4",
"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-10-22T12:06:22.1599288+00:00",
"date_create": "2025-10-22T12:06:22.1599288+00:00",
"date_update": "2025-10-22T12:06:22.1599288+00:00",
"updated_by_user_id": "410ba33b-8dcd-4006-8386-604f603d8da5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-22T12:06:22.1599288+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-10-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-22T12:06:22.1599288+00:00",
"date_last_job": "2025-10-22T12:06:22.1599288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-22T12:06:22.1599288+00:00",
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00",
"is_mobile_installation": true
},
"job_type_id": "9551702e-df52-4e03-8085-aad0c9272b33",
"job_type_code": "sample string 7",
"job_type": {
"id": "225fba92-a4fd-46d0-aa8b-4d3f53d3fb2a",
"name": "sample string 2",
"sales_organization_id": "5baf56a7-3f30-4b3d-83cb-9846f7ff9c2e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00",
"code": "sample string 7"
},
"job_priority_id": "133d54f4-29ec-4a6e-b9e2-138a7f2dc040",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e6e9671-ff1d-4678-9668-b2d23bfee561",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "619efcf2-1808-46ef-bf62-804f984ad857",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"job_status_id": "8b555f4f-f2df-4c50-bc61-1dce3c37d5c8",
"job_status_code": "sample string 11",
"db_address_id": "1de3fe23-2b6f-4a79-8fdd-8ce0a551bc99",
"contact_id": "f6d5d9ae-a5a7-496c-b4c6-b5a5d2e25a56",
"requested_by_company_id": "acfa0b71-2fc7-4627-a86c-80f98333115a",
"requested_by_contact_id": "47e8a4af-40e4-4bd6-9c99-a91bb9ee5071",
"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-10-22T12:06:22.1599288+00:00",
"due_date": "2025-10-22T12:06:22.1599288+00:00",
"date_create": "2025-10-22T12:06:22.1599288+00:00",
"date_update": "2025-10-22T12:06:22.1599288+00:00",
"date_closed": "2025-10-22T12:06:22.1599288+00:00",
"suggested_user_id": "4f440bc3-3d3a-4ee3-892f-e0b4bd3f80af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9fcd9de2-1be1-467e-a7eb-ed44b9a6d8ce",
"db_language_id": "09301bcc-6630-41c2-8266-6888a85fedb2",
"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-10-22T12:06:22.1599288+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "95b05d08-ef99-40b9-9ab6-144df54cf58d",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "882f0f1b-7579-454c-aeb9-e986d5e42102",
"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": "5a2814bf-8704-4c8d-a10d-eccad25a6b7d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bdc7161a-32bd-4324-ad70-e5ca63349840"
},
"suggested_date_start": "2025-10-22T12:06:22.1599288+00:00",
"skill_id": "f7610396-8e1a-4319-ba8e-9c6b46c106c0",
"skill_code": "sample string 32",
"skill": {
"id": "202a23df-177d-411c-bbdc-a15668fd2df0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "969f1b59-6122-477b-9028-875dfd9a63a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eac8aebc-89fb-45bd-83ff-08556e89c55b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3d59d39-703b-4589-8818-b8ac671917ee",
"db_currency_id": "9540f3a3-f38d-426b-a7b9-18a3ab5e2ce3",
"db_language_id": "f8e34b28-779b-442b-95ac-5d8eadd4b61b",
"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-10-22T12:06:22.1599288+00:00"
},
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "94eb8d73-9a95-4ffb-9b19-df7897884621",
"date_reported_by_company": "2025-10-22T12:06:22.1599288+00:00",
"id2": 36,
"company_id": "006f8651-a370-4e12-938c-a7be7008b6e3",
"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": "236adfca-ee75-4df5-87f9-72a4338c96cd",
"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-10-22T12:06:22.1599288+00:00"
},
"work_instruction_details_id": "fe4cac3c-8fbf-49c3-a6fd-09355b22eab6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1e0ddc86-5507-4483-9a90-791836fdef21",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c74f6d1c-2ebb-42b8-9c19-8d464b407544",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-22T12:06:22.1599288+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": "1943127a-90d0-428e-ae20-f93a64e7aad8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-22T12:06:22.1599288+00:00"
}