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": "6ffcf479-9652-4483-b016-868ab9786049",
"jobs_id": "a85708bf-b3ff-43d7-bad4-03a62c7fa8ed",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0fd57fa9-8d8d-4998-9293-85e468284f3c",
"_parent_id": "ddfa1048-9d19-4036-b085-1fda24ac1d71",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a823f3a9-78c0-4ea6-bccd-817114447c8d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e82d96c0-b55d-4c97-acdc-281e95466ab0",
"_parent_id": "7ccdbca6-21c5-4f94-8457-6f298b12c82c",
"root_parent_id": "5ff2032e-08bf-4449-a6e7-3db34129a425",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f89a69ed-cacb-45eb-8a49-8a604fb29b33",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1ed3d094-8d79-4f08-ac8f-8e9434ca6689",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e126222a-064d-410e-aa17-19c5c458efee",
"_parent_code": "sample string 6",
"sales_organization_id": "6d50c3e2-95e3-40a7-9f0f-0ed2031197a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"equipment_model_id": "8d3ae281-eb6b-4d68-b227-639f1c642aa2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87e62667-3a3b-4755-9346-8be24649ef62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "74499323-9143-4337-9765-3c2bbd4c363e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bc97fc53-d159-4864-8b14-c68e9960ccd4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "518e45a2-6206-401f-86d6-8f448cb87dc8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"equipment_family_id": "f1d31898-0c97-4539-9a6b-69830fee2637",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1ed3d094-8d79-4f08-ac8f-8e9434ca6689",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e126222a-064d-410e-aa17-19c5c458efee",
"_parent_code": "sample string 6",
"sales_organization_id": "6d50c3e2-95e3-40a7-9f0f-0ed2031197a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"date_in_production_since": "2026-07-16T09:31:14.7570192+00:00",
"date_out_of_production_since": "2026-07-16T09:31:14.7570192+00:00",
"date_end_support": "2026-07-16T09:31:14.7570192+00:00",
"sales_organization_id": "781e2df9-cfcf-4af4-8844-fa50e7cb31ec",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+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-07-16T09:31:14.7570192+00:00"
},
"project_status_id": "808b3e22-c209-472f-ab4a-e0ca18e00873",
"project_status_code": "sample string 10",
"project_status": {
"id": "440a5160-0b73-4b8d-8abf-6a064a73202b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dad9b5d2-62cf-45b9-a6c9-77a6f12afe36",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"company_id": "83f8356f-691a-4587-bd43-adfc29a9979b",
"company_code": "sample string 12",
"db_address_id": "ccd55f03-c153-4e7c-8aa2-c891c46dfd19",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "02006f74-073f-4abe-9870-fb454a72d286",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bf516e8c-851d-4fc1-a88d-6f0fa7b05f70",
"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-07-16T09:31:14.7570192+00:00",
"date_create": "2026-07-16T09:31:14.7570192+00:00",
"date_update": "2026-07-16T09:31:14.7570192+00:00",
"updated_by_user_id": "30821dd4-4c53-47d8-b561-ad0dbce3bd1a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-16T09:31:14.7570192+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-07-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-16T09:31:14.7570192+00:00",
"date_last_job": "2026-07-16T09:31:14.7570192+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-16T09:31:14.7570192+00:00",
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00",
"is_mobile_installation": true
},
"job_type_id": "ee0e76e9-239f-443f-8cf9-8acb17f503cb",
"job_type_code": "sample string 7",
"job_type": {
"id": "e401f599-f5ee-44f5-b5f8-9259e49044b1",
"name": "sample string 2",
"sales_organization_id": "d6d1904b-4dd0-4bb6-b839-79353f4952ed",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00",
"code": "sample string 7"
},
"job_priority_id": "c92c9d0d-f577-4977-892b-b78026170995",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c905764-52e3-4d3c-b898-25870b9c7a68",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3e4ae9af-2405-415d-82c7-677f7022b677",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"job_status_id": "a59cb49f-9790-42db-ac65-6daf43fdb9cc",
"job_status_code": "sample string 11",
"db_address_id": "7358e8aa-722f-4ba4-8418-b22819a08c16",
"contact_id": "3b6beaf7-786d-4bd0-92bb-df8baa22282b",
"requested_by_company_id": "65efcfa7-ddd8-45c9-87d8-997f36ef24e1",
"requested_by_contact_id": "d92249f8-545a-4249-bc2a-01df89953a29",
"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-07-16T09:31:14.7570192+00:00",
"due_date": "2026-07-16T09:31:14.7570192+00:00",
"date_create": "2026-07-16T09:31:14.7570192+00:00",
"date_update": "2026-07-16T09:31:14.7570192+00:00",
"date_closed": "2026-07-16T09:31:14.7570192+00:00",
"suggested_user_id": "6d23c6dd-53e5-44ad-965e-b1272946185d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6611139b-9fdf-4c2f-9203-5f47768a414b",
"db_language_id": "8d7cfb62-edec-4dee-904a-031d16a33cc1",
"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-07-16T09:31:14.7570192+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "28be47a0-78a1-4fb5-bf15-e81e756ee247",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "edd040ee-a0c2-4772-8bb2-71084165278f",
"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": "47d890d4-cad5-4806-9444-7eef436ce3cb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f8b05af6-fd5f-49a5-b657-dece2dbdd355"
},
"suggested_date_start": "2026-07-16T09:31:14.7570192+00:00",
"skill_id": "e7c5146e-d932-42ac-a49b-baf23507d84e",
"skill_code": "sample string 32",
"skill": {
"id": "101bf233-f219-411c-8ca0-3b2cc1add85e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "056acae7-69db-428d-9622-210e7298090b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e49c2d-b7ae-4aa6-9431-8318568ecd60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c3b478f-56d6-458b-b216-87238a839b35",
"db_currency_id": "9eef58f4-f4b2-407e-81d7-72cb24d50d4e",
"db_language_id": "32ade71a-9d26-46c8-ad86-4486d5c2e56a",
"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-07-16T09:31:14.7570192+00:00"
},
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d162c8b-b5e1-44d2-9d4d-a7d85cdafacb",
"date_reported_by_company": "2026-07-16T09:31:14.7570192+00:00",
"id2": 36,
"company_id": "f832a5b4-2171-485e-a0d5-ac6c9e8ff5ab",
"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": "badf6f97-053d-4de4-a5cd-f8dfa471960a",
"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-07-16T09:31:14.7570192+00:00"
},
"work_instruction_details_id": "8350b456-d2ac-4ae7-95f8-ba2a2a31547b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7d2200c6-309a-495e-9791-35f59376c6f7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c509da56-92b5-4a85-af6e-8d8647a9a0aa",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-16T09:31:14.7570192+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": "d62d4a22-c473-4f7c-abf8-b2690bac5c9b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-16T09:31:14.7570192+00:00"
}