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": "9ac6bda6-3bcd-46c8-983e-3c46dc2a7752",
"jobs_id": "a1097c0e-226d-404a-8fc1-d73358237275",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3d189d69-db0d-4060-b8c6-d2a54ec89454",
"_parent_id": "bfb58cd9-71d0-451b-ad1c-500c40a56468",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "324f82fa-6179-422a-b5b3-b28230585aae",
"project_reference_back_office": "sample string 5",
"project": {
"id": "eb77345b-ff95-4005-80cb-48967f101061",
"_parent_id": "4bf8ded3-8b06-45ae-9a9e-e7df40ae37b4",
"root_parent_id": "de13b86d-656f-4485-89cc-497fff1bee52",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0ccd9a2a-22b4-47ca-bb90-5986cceee5e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bf318108-a86f-440d-bba6-27642d02aa23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "75e05492-7bf0-45a2-baa2-b802af132855",
"_parent_code": "sample string 6",
"sales_organization_id": "e35e6f87-0dc5-4945-b64a-19589f137a8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"equipment_model_id": "ce8ac22e-9b31-4519-9b6a-53e5b383f874",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1039ad1d-a3c8-42bd-b932-02d65fba0ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c47839bd-1929-4114-a8c1-a115089b2717",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e52b2e9c-e7f7-420d-bbcc-0260a414150e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b8bebc41-6d27-4377-9d4e-39dfd059ff1f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"equipment_family_id": "2f0d4efe-fb8b-4fd1-b2e2-dbbef71cf4ec",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bf318108-a86f-440d-bba6-27642d02aa23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "75e05492-7bf0-45a2-baa2-b802af132855",
"_parent_code": "sample string 6",
"sales_organization_id": "e35e6f87-0dc5-4945-b64a-19589f137a8a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"date_in_production_since": "2025-12-30T11:05:29.9361293+00:00",
"date_out_of_production_since": "2025-12-30T11:05:29.9361293+00:00",
"date_end_support": "2025-12-30T11:05:29.9361293+00:00",
"sales_organization_id": "9e752d6e-09a6-48c2-aefc-c232ce6bd6d8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+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-12-30T11:05:29.9361293+00:00"
},
"project_status_id": "d6251e32-0ce8-48ce-abb8-8a0458f58987",
"project_status_code": "sample string 10",
"project_status": {
"id": "33684a61-8e28-4e9e-838e-9657899db69b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "08a9e170-5d20-4124-b5d2-ac003a46b29a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"company_id": "bc10d9bb-f041-4906-8d2e-720899c1d087",
"company_code": "sample string 12",
"db_address_id": "d5ea8b9e-94d0-411e-8a3d-294ab3c9646a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bc50fd26-8507-487b-a2b4-e926151fd1a8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "69f6b665-ac30-4054-aae7-588df61d0b2e",
"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-12-30T11:05:29.9361293+00:00",
"date_create": "2025-12-30T11:05:29.9361293+00:00",
"date_update": "2025-12-30T11:05:29.9361293+00:00",
"updated_by_user_id": "a4f3ad70-a937-44a9-b935-a6e931b28918",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-30T11:05:29.9361293+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-12-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-30T11:05:29.9361293+00:00",
"date_last_job": "2025-12-30T11:05:29.9361293+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-30T11:05:29.9361293+00:00",
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00",
"is_mobile_installation": true
},
"job_type_id": "6d9cfe80-8fd5-410d-9f4b-6b27616dcd4c",
"job_type_code": "sample string 7",
"job_type": {
"id": "873bc1eb-3604-4866-bc87-d8584a3dc6e8",
"name": "sample string 2",
"sales_organization_id": "d99fe63d-8274-4486-8e11-e11b3756374e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00",
"code": "sample string 7"
},
"job_priority_id": "69c7d2e5-54aa-42b7-bf3c-d33e950b4b3f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "34ed7a96-ba0c-4fb1-8fbc-432bba900711",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "add784aa-00d1-4503-8e91-83dd2d926016",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"job_status_id": "3f03cedf-331e-4fb6-b871-0bed339052ae",
"job_status_code": "sample string 11",
"db_address_id": "a609d237-2a65-4015-be57-95bc699aeae4",
"contact_id": "2605d972-b224-42f4-b17d-30ba70d44937",
"requested_by_company_id": "f66963e9-eb96-4797-8af9-da13ed7c6d45",
"requested_by_contact_id": "921bdc08-2297-48ac-a82c-e9e5f1238a98",
"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-12-30T11:05:29.9361293+00:00",
"due_date": "2025-12-30T11:05:29.9361293+00:00",
"date_create": "2025-12-30T11:05:29.9361293+00:00",
"date_update": "2025-12-30T11:05:29.9361293+00:00",
"date_closed": "2025-12-30T11:05:29.9361293+00:00",
"suggested_user_id": "497ddded-9158-4b13-8874-c7806a077185",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f6ed5419-7cdd-4de7-b9ef-f392bdb681f2",
"db_language_id": "cf39ae19-d7ff-436f-bb36-8c31e9f8b6d4",
"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-12-30T11:05:29.9361293+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "67690194-1c8a-4e1c-a1d0-c621ed75fbc2",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "681527dd-df1d-49b8-b620-e3342763d7f0",
"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": "5a64719c-07b7-40a2-8e4e-c668e358c93a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9b08b873-b46a-485d-9a8f-6fd01b10d8fb"
},
"suggested_date_start": "2025-12-30T11:05:29.9361293+00:00",
"skill_id": "ce47b0a7-944e-4775-bec8-9854c2bcdce9",
"skill_code": "sample string 32",
"skill": {
"id": "f9c1fd94-d029-4c05-9e6a-19aad6e18e19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "880fb9d8-0916-49b4-920a-8c3b4ac094a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6738e17f-9ab2-443f-bb0a-50706ad4f352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb974bc1-aff9-4aa7-899d-38b481d3fbeb",
"db_currency_id": "b7af597d-9928-40ea-b5d1-b7da8a9431ca",
"db_language_id": "7461ae90-7b4c-444f-b75d-9844db3e72e1",
"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-12-30T11:05:29.9361293+00:00"
},
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ce9e5e2b-e3a5-47ae-9c8c-bc3b579951eb",
"date_reported_by_company": "2025-12-30T11:05:29.9361293+00:00",
"id2": 36,
"company_id": "9319b197-1852-4785-86d4-530a68f94c04",
"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": "07fdec45-4828-4f1f-ae0f-c56a92a890ea",
"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-12-30T11:05:29.9361293+00:00"
},
"work_instruction_details_id": "551777e6-1edf-41a1-bdab-1ef5a2d9aa9d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e770e91e-47f3-471b-8cfe-63988485c9d8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "64a2feba-1b7b-4a00-b73d-6198760e29bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-30T11:05:29.9361293+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": "005f2dcf-492c-4ce0-9d92-2e00d9d5a2bd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-30T11:05:29.9361293+00:00"
}