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": "d1e04ba9-2bcc-4a68-b6fb-43ec998ba5cf",
"jobs_id": "2dc58478-dbc3-4caf-82e3-fa57f6d9bba1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7807492d-4074-4570-9353-3d2f1df70b14",
"_parent_id": "14af253a-2637-400c-84bb-50ab8d791859",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c5ead1b6-9e73-49da-96c6-49d6b7e2902a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aa7fc021-2844-4e76-929e-992a8c442ec3",
"_parent_id": "f0b4abb5-513a-4529-ae42-8ef30ea92ba2",
"root_parent_id": "21342480-0b70-4721-8539-a003c7e83fc7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e382513-dd17-423f-bc43-3bce7d91e243",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "306d5dd5-1e1f-44fa-8f74-994d99650ff9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94d29a3a-a667-43fc-a27b-88b18e3c51d8",
"_parent_code": "sample string 6",
"sales_organization_id": "607b81a5-e2b7-44ff-ae57-aca1063f7ab4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"equipment_model_id": "1a859ddf-07d1-461b-ae07-1a58718e3ae7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "77cb70d6-95fe-4710-acf5-1d622555dfc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "828cf9df-3e28-4ad5-9750-ea707f8942b4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "10beba38-7edb-42f5-8add-e5d6118da657",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca903f25-584c-46f4-94fe-15b00dda2393",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"equipment_family_id": "8a695021-aa03-4301-a8d0-d72b4ee40a36",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "306d5dd5-1e1f-44fa-8f74-994d99650ff9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "94d29a3a-a667-43fc-a27b-88b18e3c51d8",
"_parent_code": "sample string 6",
"sales_organization_id": "607b81a5-e2b7-44ff-ae57-aca1063f7ab4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"date_in_production_since": "2026-04-24T11:01:42.811812+00:00",
"date_out_of_production_since": "2026-04-24T11:01:42.811812+00:00",
"date_end_support": "2026-04-24T11:01:42.811812+00:00",
"sales_organization_id": "3e712ca1-cf4e-4443-b7ce-a904fb59cf9b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+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-04-24T11:01:42.811812+00:00"
},
"project_status_id": "d47f66fc-2f3f-42f1-be26-dc633a375d30",
"project_status_code": "sample string 10",
"project_status": {
"id": "92d6ddea-ac80-4b2c-b530-6353eb619ee9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15bfbea4-6c8c-441f-87de-6226032774ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"company_id": "c481695e-5691-4a42-872b-9d8d43c01402",
"company_code": "sample string 12",
"db_address_id": "1a6b3e63-eebf-415c-9d7f-ca68e6c70ac2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "44f142cb-04fe-4a58-8bee-94d844e42e58",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2c4b7bec-d43c-49e0-a79d-2004e92d810e",
"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-04-24T11:01:42.811812+00:00",
"date_create": "2026-04-24T11:01:42.811812+00:00",
"date_update": "2026-04-24T11:01:42.811812+00:00",
"updated_by_user_id": "8dd7b42f-5d71-4d5a-8feb-8f4d57752693",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T11:01:42.811812+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-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T11:01:42.811812+00:00",
"date_last_job": "2026-04-24T11:01:42.811812+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T11:01:42.811812+00:00",
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec0fa1f8-5da7-40ca-ab7a-ff0e256f70ab",
"job_type_code": "sample string 7",
"job_type": {
"id": "e1767432-8256-4a49-9dab-ec7b05c4b8d6",
"name": "sample string 2",
"sales_organization_id": "57a82f66-a9ce-4a99-8b50-09338bf5140c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00",
"code": "sample string 7"
},
"job_priority_id": "93f0dc83-77fd-48bd-bd2e-12851d3a8f19",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a259e323-20b1-47e4-88c9-4777dcb18bd7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a3365c4d-3bef-44db-8144-ae2be482e5d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"job_status_id": "2155221b-6760-4547-a66a-8fe416a72a83",
"job_status_code": "sample string 11",
"db_address_id": "71cd4935-4e69-4762-bcb6-9b68ced40992",
"contact_id": "dbfe2541-4575-4812-8f63-5b2f32d479b6",
"requested_by_company_id": "a55e4a40-fce4-4803-b721-eb232b5f38c1",
"requested_by_contact_id": "ca4ec07e-2c13-4578-9d1d-532046bb05c5",
"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-04-24T11:01:42.811812+00:00",
"due_date": "2026-04-24T11:01:42.811812+00:00",
"date_create": "2026-04-24T11:01:42.811812+00:00",
"date_update": "2026-04-24T11:01:42.811812+00:00",
"date_closed": "2026-04-24T11:01:42.811812+00:00",
"suggested_user_id": "66738350-bfec-4523-a39f-05d08cd71f5a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e8ce5783-2b7d-4bf5-9625-ebe71ac1cfa7",
"db_language_id": "845241f5-c3bc-4d97-ac80-6120684f661f",
"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-04-24T11:01:42.811812+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "221057f5-84bf-4af1-8356-265710dcad75",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "57076104-0276-4aba-9575-dcdb06a52cb9",
"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": "18ba6307-2ff1-46c7-b1e0-7d06eefa35d0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f6359e96-07c1-4f48-9b05-ee257f4d55bf"
},
"suggested_date_start": "2026-04-24T11:01:42.811812+00:00",
"skill_id": "e3d81afb-ee7e-4722-9c8b-4ded7d853d38",
"skill_code": "sample string 32",
"skill": {
"id": "1a7af37f-b211-40f0-ba4c-c2b9add7fd35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "93bed82c-f3c0-49ab-99ab-9ba95612cc77",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "303ff519-7c1e-4777-bdc2-9aaceaafcc14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4a7b36e-bb91-41af-a594-2e1ce6108df4",
"db_currency_id": "ebda1db2-5760-4b52-b210-2237743712d6",
"db_language_id": "3d5ed30c-03e0-4b1e-ae1e-682c31928b58",
"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-04-24T11:01:42.811812+00:00"
},
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d03e7cb8-359e-4fab-85db-8a173ef97884",
"date_reported_by_company": "2026-04-24T11:01:42.811812+00:00",
"id2": 36,
"company_id": "d2d52166-c255-4714-8d58-1d60033f210c",
"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": "6b282426-9958-45be-a1eb-47f17f63ac1b",
"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-04-24T11:01:42.811812+00:00"
},
"work_instruction_details_id": "6ea23c9c-dd45-486a-89be-1b801e256fbd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "aea87135-5d0b-40cf-a86d-429b4f7cdc1e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d60ba4e5-ea19-499a-9b18-dec1255b1d63",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T11:01:42.811812+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": "548c4d13-3805-495b-b1cd-76d19e36f66f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T11:01:42.811812+00:00"
}