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": "75db8eb3-7980-4b28-8ce2-356777ab8c03",
"jobs_id": "7bf66cfb-3b9b-4bbb-b8ef-5d7f639a4cd9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "945d5ea0-d2be-4891-8694-784ff9fe0a3c",
"_parent_id": "50c0dc70-91b2-4bf1-8b2d-dbd6dd31bd70",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6454f333-73cc-4fba-81f6-079938d5f73e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "48d4021e-641e-4b28-b4ac-f15975d965b8",
"_parent_id": "e84fa28b-54ba-445e-919f-f009bdaaeacc",
"root_parent_id": "84f1773f-ea93-45e1-99fb-40ea85a8fa1a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7855bd10-ae13-40dd-acd7-7e8afae95397",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "60804e69-5d5b-42b6-b2bc-1b26020ac34f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52370b0b-f74c-4ef2-b6eb-b61b735edf43",
"_parent_code": "sample string 6",
"sales_organization_id": "4d1b211b-6e68-4422-9b3d-619257964ae2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"equipment_model_id": "035e4513-4c93-48c1-acfc-157e688c0418",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "20508450-7df9-41fd-a68f-c0bbd0be8909",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "563a56fc-be7a-4ce3-b9cb-65eb5d409ee0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a61afe24-e744-46d3-a54b-33dfff210d40",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "49f764d4-af61-46d0-8ba7-e46387dee002",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"equipment_family_id": "e1f6780a-ebae-4a17-9249-8b6939219af4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "60804e69-5d5b-42b6-b2bc-1b26020ac34f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52370b0b-f74c-4ef2-b6eb-b61b735edf43",
"_parent_code": "sample string 6",
"sales_organization_id": "4d1b211b-6e68-4422-9b3d-619257964ae2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"date_in_production_since": "2025-03-31T13:23:33.6971725+00:00",
"date_out_of_production_since": "2025-03-31T13:23:33.6971725+00:00",
"date_end_support": "2025-03-31T13:23:33.6971725+00:00",
"sales_organization_id": "3dd620ef-75ce-488b-a251-c96b8bb3254c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+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-03-31T13:23:33.6971725+00:00"
},
"project_status_id": "cede6015-2111-4a4a-833d-29c466901bbc",
"project_status_code": "sample string 10",
"project_status": {
"id": "bc8c6642-8026-4341-bfd5-7e9724e0ea78",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "abfce05b-f5c2-4d01-863d-e63e879acb6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"company_id": "aa9d4d85-9c24-4da6-b6a6-4fd625d8d440",
"company_code": "sample string 12",
"db_address_id": "370f9f22-9e7c-4b52-a346-16b403013c9f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "13c613b9-beb0-4dce-a84b-098b9498f493",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1a03612f-a1e1-4d9f-88c3-239cc3ca92ac",
"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-03-31T13:23:33.6971725+00:00",
"date_create": "2025-03-31T13:23:33.6971725+00:00",
"date_update": "2025-03-31T13:23:33.6971725+00:00",
"updated_by_user_id": "2a87e1a3-cec0-4734-825a-0dd4a207b64c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-31T13:23:33.6971725+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-03-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-31T13:23:33.6971725+00:00",
"date_last_job": "2025-03-31T13:23:33.6971725+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-31T13:23:33.6971725+00:00",
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00",
"is_mobile_installation": true
},
"job_type_id": "91a9af7a-a82b-406d-9b75-5b62dffa8059",
"job_type_code": "sample string 7",
"job_type": {
"id": "77eb15c2-d6c0-4819-b49e-ab4a62eeb18d",
"name": "sample string 2",
"sales_organization_id": "d86df476-bde4-4bb3-b99c-6a23f52c5e9f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00",
"code": "sample string 7"
},
"job_priority_id": "87a443fc-58a8-4a3c-9211-a39cf7dba9b1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4ef8b3a2-99cd-4b6a-801a-481a37847bf9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "af163f4d-f656-480b-b576-4b87272c222d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"job_status_id": "cf3e4be8-ad86-490d-84f7-7c0b5a2d1c18",
"job_status_code": "sample string 11",
"db_address_id": "d7139652-9073-4748-8ee8-428550ad4bf2",
"contact_id": "fbae9ed9-cd31-40d2-b918-08f13ac92a76",
"requested_by_company_id": "76e1775f-fb93-4b60-b846-2749e2d494bc",
"requested_by_contact_id": "4dea13e2-3bb5-42f3-a4d5-6712fd2503cc",
"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-03-31T13:23:33.6971725+00:00",
"due_date": "2025-03-31T13:23:33.6971725+00:00",
"date_create": "2025-03-31T13:23:33.6971725+00:00",
"date_update": "2025-03-31T13:23:33.6971725+00:00",
"date_closed": "2025-03-31T13:23:33.6971725+00:00",
"suggested_user_id": "814fa128-6e98-4fb8-b7fd-2401f22e0257",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "db1e52c1-32d8-4501-b040-b6cb49f69b5b",
"db_language_id": "f5424b71-419a-48d3-9c2d-1c65b3eeb33f",
"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-03-31T13:23:33.6971725+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ac1fbcdf-b38a-4338-8244-bbebf983ef3b",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cab6e3e3-5e18-4819-a9cb-5e54a613f5db",
"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": "49faf2f2-e792-43c5-9024-3c72cf58bf3d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a88251a5-711e-4518-8502-1e783c90408f"
},
"suggested_date_start": "2025-03-31T13:23:33.6971725+00:00",
"skill_id": "df1bb871-9120-4254-844f-35b81035577d",
"skill_code": "sample string 32",
"skill": {
"id": "79a90bda-d331-4db0-a620-a1245308b957",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3ede6839-5eae-48c5-b091-97da66327add",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c9219114-49ba-4d3a-a577-87f88784279a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7a2ae9f-6773-493a-a2b9-d6d7a88a9c0a",
"db_currency_id": "543cfd11-346c-4da5-82fd-a2323bddabdf",
"db_language_id": "eef91369-d8ec-4598-9db6-d66238ffb57a",
"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-03-31T13:23:33.6971725+00:00"
},
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "17f72987-938e-42f8-b2e9-aa4d2d399a96",
"date_reported_by_company": "2025-03-31T13:23:33.6971725+00:00",
"id2": 36,
"company_id": "e7249b92-6dd0-48c3-8391-0a54baf5d03a",
"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": "5538038d-3993-4519-ae57-1fa30a29df0d",
"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-03-31T13:23:33.6971725+00:00"
},
"work_instruction_details_id": "d68ff4a1-fa55-40e0-814a-411d6327c4a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6476e646-de5b-47f8-b01b-b183fbbb85fd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03b94dd5-d68b-4637-a1e4-23a95a008882",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-31T13:23:33.6971725+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": "2991225a-655c-4a57-86ab-28a717d616ef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-31T13:23:33.6971725+00:00"
}