Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "7a74d89a-edd8-41e2-8b34-1bb7c83ecb67",
"jobs_id": "93007dba-55b2-45e6-9058-19fd6d598f31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5cae2ce2-e688-45f3-a7f4-e300d7fd464a",
"_parent_id": "a2b4c20c-6f9e-4922-9759-2f03f5377e68",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ba9e2131-e2db-4e40-acde-62f1e45764a0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a7a27321-6363-4913-9726-2213fa6c431c",
"_parent_id": "85305f8f-dae2-4b16-9a37-df019541db2f",
"root_parent_id": "9f3d0102-e1c2-4080-82e0-d418827e201d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a6e36479-78dc-4b1a-a4e9-634d42bd6b23",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6e1b0cfd-8260-483b-8f50-2e0bdb4627ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94ca9ff1-f3c4-42e9-8d0f-fa8244a1d0e9",
"_parent_code": "sample string 6",
"sales_organization_id": "f3f51ed7-5de1-45bb-ac3d-c3c6b8e9d65a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"equipment_model_id": "7b3e35de-ab29-48bc-aeb3-e806abf6bb58",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d858bfd3-5231-4fe0-8287-1555fd2077ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9c094913-6a46-4102-9e95-b4ba006a09fa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "28e05711-2013-4a7d-b970-be2bc0726d6f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3bd04080-65a2-47f9-9889-65a6f6086fe3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"equipment_family_id": "d0cf564c-8850-4e2d-9d69-15cf1b534e8d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6e1b0cfd-8260-483b-8f50-2e0bdb4627ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94ca9ff1-f3c4-42e9-8d0f-fa8244a1d0e9",
"_parent_code": "sample string 6",
"sales_organization_id": "f3f51ed7-5de1-45bb-ac3d-c3c6b8e9d65a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"date_in_production_since": "2025-06-21T11:45:24.8889968+00:00",
"date_out_of_production_since": "2025-06-21T11:45:24.8889968+00:00",
"date_end_support": "2025-06-21T11:45:24.8889968+00:00",
"sales_organization_id": "93c4bb50-d426-4c57-a6d5-2c0b7eb48752",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+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-06-21T11:45:24.8889968+00:00"
},
"project_status_id": "96445d7f-52b8-4f34-bae4-b436cbb85ed2",
"project_status_code": "sample string 10",
"project_status": {
"id": "936ab9a4-98a8-4078-aefe-e69de5bec1dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8a4c1987-da84-4fcd-900c-0daf0429a6f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"company_id": "e359906e-6de9-4948-81a2-1686e39ec505",
"company_code": "sample string 12",
"db_address_id": "15555471-1550-49d7-a583-78427d8ef2cd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "03c3ef3d-c4a9-41d8-aaa4-a953c6e35f3b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6a2bf50f-8a72-4fec-8047-406a74107f97",
"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-06-21T11:45:24.8889968+00:00",
"date_create": "2025-06-21T11:45:24.8889968+00:00",
"date_update": "2025-06-21T11:45:24.8889968+00:00",
"updated_by_user_id": "06a9b3e1-9de3-4a28-b8d3-40b56e7dd447",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-21T11:45:24.8889968+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-06-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-21T11:45:24.8889968+00:00",
"date_last_job": "2025-06-21T11:45:24.8889968+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-21T11:45:24.8889968+00:00",
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00",
"is_mobile_installation": true
},
"job_type_id": "39d1c09f-7d86-4190-8821-c9270724f13e",
"job_type_code": "sample string 7",
"job_type": {
"id": "bb3ebb4a-8fc1-4fd5-83e5-10db358862e5",
"name": "sample string 2",
"sales_organization_id": "ce374c99-d22b-43b7-b5a0-86f9b4f4db93",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00",
"code": "sample string 7"
},
"job_priority_id": "d7f38183-431a-47c2-a56c-f05cbb3be86b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0437835b-f308-4952-b9fd-af2f3ad4311c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "caec427d-41a9-4efa-be7a-d7e359bb8be4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"job_status_id": "07c5532c-0720-49ae-995f-7884ec0e1b30",
"job_status_code": "sample string 11",
"db_address_id": "70558e01-e29a-4375-b95b-8abf69f64e18",
"contact_id": "f1c92be9-bcb6-4276-bd52-379d0a728f99",
"requested_by_company_id": "bf84b8c9-d49f-4b33-b3eb-78640dc0a39a",
"requested_by_contact_id": "a74d58a7-d336-4d30-acea-6e93996051dd",
"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-06-21T11:45:24.8889968+00:00",
"due_date": "2025-06-21T11:45:24.8889968+00:00",
"date_create": "2025-06-21T11:45:24.8889968+00:00",
"date_update": "2025-06-21T11:45:24.8889968+00:00",
"date_closed": "2025-06-21T11:45:24.8889968+00:00",
"suggested_user_id": "60fc5a28-e427-4f7a-abd4-8e43d1752b98",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4cce4bc7-d79b-49ea-8bbf-e8dafad5eb69",
"db_language_id": "3efee1f1-f00e-4fb7-a739-89bc5360cb17",
"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-06-21T11:45:24.8889968+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6c7ec4ce-295e-41d8-83a9-c989240f2246",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "72511bb2-3bf8-4ba2-9f61-4f3d31b8c4a6",
"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": "36d98ca9-458a-4c75-bd71-47a8a4733526",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3c59826d-6042-4d74-a244-38fa38dede8b"
},
"suggested_date_start": "2025-06-21T11:45:24.8889968+00:00",
"skill_id": "71c1cd0d-9016-4858-a2bc-23526c345a56",
"skill_code": "sample string 32",
"skill": {
"id": "f90a73ee-0ba5-4299-a748-15bdda4a30b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ebaca7a1-8f78-40e8-8d16-42a8d81095c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "21d1549a-eddb-4233-ab78-44462844b6bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8641503e-f212-4641-855e-7b6d4ad7ffbb",
"db_currency_id": "32bc3956-54cd-4e29-ada1-4cdf72b97872",
"db_language_id": "12b9d7ea-e04f-4ec3-af51-dbad0fc8f134",
"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-06-21T11:45:24.8889968+00:00"
},
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "168fc8c5-be5f-4f54-b09f-000e29df25f8",
"date_reported_by_company": "2025-06-21T11:45:24.8889968+00:00",
"id2": 36,
"company_id": "0801fdb7-de61-4d78-9969-1a3b2803a6b2",
"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": "f0ccf35d-0d6f-4fe5-89de-2fc751758c48",
"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-06-21T11:45:24.8889968+00:00"
},
"work_instruction_details_id": "7e62d324-9653-4dba-8f5f-ab5cdf4736c4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "51dc2333-9718-4f9e-b923-92b255ac0665",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c6188c2c-6ce9-4116-a57b-bab7e7556cc3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-21T11:45:24.8889968+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": "53f6a533-712e-4578-94e7-14bd4f8d6874",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-21T11:45:24.8889968+00:00"
}