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": "39d23221-1e24-47f5-a287-182f65e88b94",
"jobs_id": "bac1b458-d4e8-4a78-974b-1bed9c7c044a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2eaec2cd-9c97-442e-824c-0bd1d122ffbb",
"_parent_id": "79793e58-e35c-4aae-bd01-7d80a51f9d76",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "853b09ff-0125-4d9c-8547-c7b7fd94228a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "938e1632-20c1-4255-afb7-e7bcf7723681",
"_parent_id": "ee4ff0f6-3b9f-4402-950d-a1ed41f63e15",
"root_parent_id": "b1cc95f6-f6a1-436f-8aee-f79016624a09",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b3930bb9-29e3-47e9-a171-59550e0c81e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "661f8fd2-f3f3-4a83-aa9d-a586e511bd4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf6e3e36-b411-477a-a685-71dc78619f75",
"_parent_code": "sample string 6",
"sales_organization_id": "aadcfab7-8dd4-46ed-9fb4-079db2e122c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"equipment_model_id": "e5da1151-7449-4f1b-8990-64cfcb4de3b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fa698379-363b-4902-b88a-d7e4707392ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3cbf06c5-7aa7-49b2-8449-58f49428c56d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "75724b79-a601-4db8-9dc0-0273711fb962",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "831cc5fd-8cba-4cdb-b166-927787f1d104",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"equipment_family_id": "0c23be0c-6a3e-41ef-9f28-241a2c7a796d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "661f8fd2-f3f3-4a83-aa9d-a586e511bd4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf6e3e36-b411-477a-a685-71dc78619f75",
"_parent_code": "sample string 6",
"sales_organization_id": "aadcfab7-8dd4-46ed-9fb4-079db2e122c6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"date_in_production_since": "2025-09-04T20:25:38.9557445+00:00",
"date_out_of_production_since": "2025-09-04T20:25:38.9557445+00:00",
"date_end_support": "2025-09-04T20:25:38.9557445+00:00",
"sales_organization_id": "fe2189b3-1034-4656-905c-16396df93cf7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+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-09-04T20:25:38.9557445+00:00"
},
"project_status_id": "7d80ff21-d13f-48da-8d1a-bde1477e4b11",
"project_status_code": "sample string 10",
"project_status": {
"id": "28ccc4a8-0963-4527-97d7-830a96efd091",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f69c43c0-6ccc-4ad9-b414-815a8fd717c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"company_id": "4710feb5-4044-4c56-be7f-95a54d0247d2",
"company_code": "sample string 12",
"db_address_id": "0ae95188-9e52-4498-91af-e493f7a1c2a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "62c6f7eb-b7e3-4003-a0a2-40a976d54cf1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "982ddc88-a298-48c2-a3dd-d76829371b85",
"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-09-04T20:25:38.9557445+00:00",
"date_create": "2025-09-04T20:25:38.9557445+00:00",
"date_update": "2025-09-04T20:25:38.9557445+00:00",
"updated_by_user_id": "6826691b-4e93-45d4-b75c-fc54f39af3ff",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-04T20:25:38.9557445+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-09-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-04T20:25:38.9557445+00:00",
"date_last_job": "2025-09-04T20:25:38.9557445+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-04T20:25:38.9557445+00:00",
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f26595b-6a8d-44bb-834a-7f58234afde7",
"job_type_code": "sample string 7",
"job_type": {
"id": "1d7cda32-e67b-4793-a2af-56ee928d75d7",
"name": "sample string 2",
"sales_organization_id": "bdf1be92-212d-4f72-8c41-d4ba17e4f04e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00",
"code": "sample string 7"
},
"job_priority_id": "37a9c058-af1b-4fd6-9c58-a9a572f0bf91",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "911aaf82-3912-4c68-95cc-08d810624103",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "31dc13bb-5bff-4d8c-b13d-4b4db8e8bcf1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"job_status_id": "828a8fac-5108-4d04-a13e-159148fd54af",
"job_status_code": "sample string 11",
"db_address_id": "aee50d04-88f8-4bff-be05-4a54684cc8ca",
"contact_id": "08789ea2-e0b9-4ee2-8b46-d5a086640473",
"requested_by_company_id": "ef9578b7-2d4b-4ef8-a2ca-0e52d4329c0b",
"requested_by_contact_id": "451f193c-0f38-4287-b47c-fab2737cfd37",
"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-09-04T20:25:38.9557445+00:00",
"due_date": "2025-09-04T20:25:38.9557445+00:00",
"date_create": "2025-09-04T20:25:38.9557445+00:00",
"date_update": "2025-09-04T20:25:38.9557445+00:00",
"date_closed": "2025-09-04T20:25:38.9557445+00:00",
"suggested_user_id": "5859af73-64b7-487c-9566-4f85a6a7cee1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a98d6b80-8833-4043-bc5f-4266483ab4a1",
"db_language_id": "654546ee-fdde-464b-ac17-e75a9565b660",
"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-09-04T20:25:38.9557445+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f170bbc3-0603-4354-bb66-fc49b6f8b16b",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3a054ca2-b8f8-4b27-bba9-f0b72ebf0dae",
"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": "6dfafa99-39e1-4189-914c-548f3adf35df",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "add2c56b-2b1c-4d59-a5da-59ef8f4eee06"
},
"suggested_date_start": "2025-09-04T20:25:38.9557445+00:00",
"skill_id": "5e32ae9a-8f58-4ef3-b1f0-3e8b93d8ef40",
"skill_code": "sample string 32",
"skill": {
"id": "ca6e7b96-8a77-4e83-84c1-a8471e1f8a98",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5903f1a1-22b3-4da6-af60-5206598e28aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa4739cc-fbfd-443f-a568-d182a781d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00214504-9099-454f-81dd-5df313218a2a",
"db_currency_id": "f9168505-4331-4c76-baa8-02b4307ce3b2",
"db_language_id": "ae311bb5-1259-4def-aecf-3a628976fb01",
"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-09-04T20:25:38.9557445+00:00"
},
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5870eaa4-0786-43e2-8e90-c04ff28b513f",
"date_reported_by_company": "2025-09-04T20:25:38.9557445+00:00",
"id2": 36,
"company_id": "c578d6e1-5182-4d4f-8ddf-69d2edd1c6ef",
"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": "78254cff-4a33-4e4f-bae5-015a5b166ba7",
"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-09-04T20:25:38.9557445+00:00"
},
"work_instruction_details_id": "6db914d2-0c40-44e4-87c9-b68c9c9bc95e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e4d8249f-a2a5-4cac-93dc-b30b24a02632",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "61d9431a-fc89-4ac9-83b4-a72ba6b139ce",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-04T20:25:38.9557445+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": "929fe443-1b77-4222-a1e7-7e805da351a8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-04T20:25:38.9557445+00:00"
}