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": "7dddbad0-0bed-45ec-8d2c-0c2cf25d4ae2",
"jobs_id": "49cda0a9-adc3-4d9f-9a56-e350817c76df",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "35265ba7-f5ae-43b0-963c-a22ad442903b",
"_parent_id": "c9e96e86-e452-4cbc-bca5-937ad1d541b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e0ca789a-d78d-402d-9177-83756ef12a0e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da5f5fd1-7a7c-4405-8524-cce786259440",
"_parent_id": "50a27069-76da-4607-9d3e-91f401e740f6",
"root_parent_id": "47187ca3-d001-48fa-8eaa-f5a2e5c7f715",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f9ac27fa-2c06-4079-b82e-30dbc8395666",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4f7aa758-6b2c-4bc2-beaf-cac1ebc15775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86e94470-9185-43f3-8545-f1f288397e65",
"_parent_code": "sample string 6",
"sales_organization_id": "9232d5c8-1ed2-44d6-95e0-1b2711ee5a6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00"
},
"equipment_model_id": "c13d067a-9a27-47e5-abbd-1c33abd57cdd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7031c001-7085-473c-a621-759f85d395af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9cdbb9c1-c984-40b7-ad53-c17dc320fd60",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b483b485-2611-4edc-9d87-dbc179245de8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a940ad8-ff27-4440-821f-e3ddfa203772",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00"
},
"equipment_family_id": "c41cc62e-0de3-4038-9fd6-8dac4ed42e5a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4f7aa758-6b2c-4bc2-beaf-cac1ebc15775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86e94470-9185-43f3-8545-f1f288397e65",
"_parent_code": "sample string 6",
"sales_organization_id": "9232d5c8-1ed2-44d6-95e0-1b2711ee5a6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00"
},
"date_in_production_since": "2026-03-07T14:14:35.805437+00:00",
"date_out_of_production_since": "2026-03-07T14:14:35.805437+00:00",
"date_end_support": "2026-03-07T14:14:35.805437+00:00",
"sales_organization_id": "63c546ca-f3a4-4372-ba9b-ac4682d727c2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+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-03-07T14:14:35.805437+00:00"
},
"project_status_id": "361b2228-010e-4ab7-9b8f-a8dce0752b29",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd6482d8-983a-4f3f-bb71-66405d0fbc98",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50177227-e300-4dda-aaa2-0b756fd89d08",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00"
},
"company_id": "85aa7180-c7c8-4ddd-8236-d6839f8707fb",
"company_code": "sample string 12",
"db_address_id": "b3319364-5da3-4540-a1e5-9609f74f4304",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c5dd0e58-e273-425d-bf36-855b56a0625b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4d8777cc-7dab-4db9-8f7e-2386fe721f95",
"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-03-07T14:14:35.805437+00:00",
"date_create": "2026-03-07T14:14:35.805437+00:00",
"date_update": "2026-03-07T14:14:35.805437+00:00",
"updated_by_user_id": "9488a30d-21a8-48ac-875c-22cbd0d7858c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-07T14:14:35.805437+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-03-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-07T14:14:35.805437+00:00",
"date_last_job": "2026-03-07T14:14:35.805437+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-07T14:14:35.805437+00:00",
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00",
"is_mobile_installation": true
},
"job_type_id": "0b82b9fc-6a66-483b-a8f0-1fec9e2959c6",
"job_type_code": "sample string 7",
"job_type": {
"id": "875967f3-1e3b-4897-a0bb-8f096f390bb3",
"name": "sample string 2",
"sales_organization_id": "bb1e6401-e5dc-4cea-be0c-529fef9e397b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00",
"code": "sample string 7"
},
"job_priority_id": "e4f568f4-b52f-42b5-a014-8b076b9ce6dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e9ca8edb-5b60-47f7-a53e-f78957322b45",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a3a8b514-353c-42c6-918e-f42efa70bfab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T14:14:35.805437+00:00"
},
"job_status_id": "5655cc9f-c443-42d0-bc87-7ab89524818a",
"job_status_code": "sample string 11",
"db_address_id": "5d685b3a-8105-44d6-a638-4ee7bd0402f9",
"contact_id": "595f5833-0184-44a1-b439-e5c6cdb0e94a",
"requested_by_company_id": "616c9c50-480b-445d-999b-d3f6ee898650",
"requested_by_contact_id": "69bbd0f4-2695-4e3d-a2f6-6c2fa65a9295",
"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-03-07T14:14:35.805437+00:00",
"due_date": "2026-03-07T14:14:35.805437+00:00",
"date_create": "2026-03-07T14:14:35.805437+00:00",
"date_update": "2026-03-07T14:14:35.805437+00:00",
"date_closed": "2026-03-07T14:14:35.805437+00:00",
"suggested_user_id": "63281ae6-37e7-4c60-8bbe-a2708cdfd347",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "147eaccf-e944-4876-836f-804236949e28",
"db_language_id": "b6bccfef-6b5e-404d-98c3-d3de123456ea",
"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-03-07T14:14:35.805437+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f3d2bf4-b8ec-44ea-85f7-8d607726cab7",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "23f51fcc-294f-4b74-8c8e-ab5fb197be6f",
"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": "08c30a86-eb95-4405-bd91-ac8fc55474bb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-07T14:14:35.8210641+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ae9eab88-633c-425e-92a2-3bf371c20208"
},
"suggested_date_start": "2026-03-07T14:14:35.8210641+00:00",
"skill_id": "d5992d8f-a830-4081-80ba-d1395d98f3ca",
"skill_code": "sample string 32",
"skill": {
"id": "7419597f-825f-40e4-bf4e-a42e7de4d3be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "00aef742-2b29-4ffa-bce3-79cb875387f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4e6d0a-ba79-4606-8d74-12a7892033da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039dbd09-4bf4-4b57-b4f2-18720f6811e4",
"db_currency_id": "6ca66f71-737a-46cf-af2b-3c1a98854a15",
"db_language_id": "7ea610d6-d411-46d9-98fb-82115e83a00b",
"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-03-07T14:14:35.805437+00:00"
},
"modified_dateutc": "2026-03-07T14:14:35.8210641+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e6fe0edd-a91e-4130-ae9f-19595b10aaac",
"date_reported_by_company": "2026-03-07T14:14:35.8210641+00:00",
"id2": 36,
"company_id": "b5901c3a-2414-40ed-a1e3-0b1c9a621340",
"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": "9448c7e6-c4cb-484a-a47c-c25e2c753025",
"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-03-07T14:14:35.8210641+00:00"
},
"work_instruction_details_id": "6f38f8bc-374b-432b-a9d0-37e886f71ff0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "97169105-da7b-4f0c-bd56-135b008bab1b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "84cf4f6a-1ea6-43d2-9f29-5304430ed86c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-07T14:14:35.8210641+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": "9a87e0a0-a901-49fc-99fe-d548863b13e4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-07T14:14:35.8210641+00:00"
}