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": "1c9bb0ef-0d2c-4690-890e-4b46f08bfaa1",
"jobs_id": "231af03c-d017-454a-8574-6abf7fe6a86f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fc88f48c-9e48-47f3-89ab-bf3c1f1b3325",
"_parent_id": "80761c1a-6654-4c9f-9081-53589387acbf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "77ab4eac-4436-4a2b-86e9-9ea497fc5431",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ae3ac590-3f98-4586-aa5f-b6fd4dcb67d0",
"_parent_id": "79db7cbf-a32e-4422-a899-7e87f9c6a100",
"root_parent_id": "1c33f8c9-8a07-4675-8254-34da4d54cc32",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4e317456-ae43-4f6a-be98-974d0a55b327",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9bc5ad80-bb54-4763-b688-0d6f49db5f79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e7264ade-8c64-4d99-8aa2-913998983c84",
"_parent_code": "sample string 6",
"sales_organization_id": "1fc6aaeb-c3b4-4023-8ecf-c26316149a4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"modified_dateutc": "2025-11-22T09:18:29.3134837+00:00"
},
"equipment_model_id": "a76350ec-0cb3-480e-b71c-a932ca3605ab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ba1be79d-6f78-4059-8a66-8d3ee6189718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f42dc8b7-5ae5-4e6f-b951-286d535fc075",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0f1d93e5-7490-4ced-94fb-d314135b4e94",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2694d813-2729-4f76-93c6-2a886ace7c90",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"modified_dateutc": "2025-11-22T09:18:29.3134837+00:00"
},
"equipment_family_id": "ff1043d0-c4a2-413c-8f5f-3d1783a99cad",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9bc5ad80-bb54-4763-b688-0d6f49db5f79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e7264ade-8c64-4d99-8aa2-913998983c84",
"_parent_code": "sample string 6",
"sales_organization_id": "1fc6aaeb-c3b4-4023-8ecf-c26316149a4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"modified_dateutc": "2025-11-22T09:18:29.3134837+00:00"
},
"date_in_production_since": "2025-11-22T09:18:29.3134837+00:00",
"date_out_of_production_since": "2025-11-22T09:18:29.3134837+00:00",
"date_end_support": "2025-11-22T09:18:29.3134837+00:00",
"sales_organization_id": "76236392-c7fc-4657-b8bd-f72dcbfb8736",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+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-11-22T09:18:29.329106+00:00"
},
"project_status_id": "1f176020-b0cf-4818-a45d-7354f9c2fac7",
"project_status_code": "sample string 10",
"project_status": {
"id": "acf1a814-9057-4675-a018-6aff00bfc8af",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cea20ce1-2f3d-4779-97ab-b3ed2bb15580",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00"
},
"company_id": "fc80c8b6-316d-4c5f-b980-64039cf3e7ff",
"company_code": "sample string 12",
"db_address_id": "375d9805-c7c9-4b35-ae1b-8954f76b9262",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f06df569-bd1d-41c9-9274-4565cde069f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2eacf2b2-7203-4385-aef3-8ca45157648b",
"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-11-22T09:18:29.329106+00:00",
"date_create": "2025-11-22T09:18:29.329106+00:00",
"date_update": "2025-11-22T09:18:29.329106+00:00",
"updated_by_user_id": "7fef29f2-3705-4c72-adab-d26669f9ea3a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T09:18:29.329106+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-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T09:18:29.329106+00:00",
"date_last_job": "2025-11-22T09:18:29.329106+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T09:18:29.329106+00:00",
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00",
"is_mobile_installation": true
},
"job_type_id": "ff342274-f9aa-4870-a035-b7e28b292aa0",
"job_type_code": "sample string 7",
"job_type": {
"id": "624845e1-1d49-49a9-bef9-ae3764fb2f0b",
"name": "sample string 2",
"sales_organization_id": "24b4ad1f-e404-42e7-a5a2-fdbf01152de0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00",
"code": "sample string 7"
},
"job_priority_id": "c3446b25-066c-4135-968a-c60d9940ef1e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ac6c6de5-70c2-4892-b7f6-7ed2a8dab64c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "89a9d0ed-b861-49b8-af9c-9e3f54324e05",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00"
},
"job_status_id": "5d917ffb-8f09-4020-8223-5d460e28ecc2",
"job_status_code": "sample string 11",
"db_address_id": "f63d7cb2-cc3e-4ef1-bbc8-1a6fa58a0e82",
"contact_id": "6c1505b4-1415-467d-afab-4b0d4cf04707",
"requested_by_company_id": "a7d70496-5f8f-4ff5-b26b-74b0c6f4ca7b",
"requested_by_contact_id": "3619a50d-c4a3-494c-beb7-21d0e3a5a5a7",
"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-11-22T09:18:29.329106+00:00",
"due_date": "2025-11-22T09:18:29.329106+00:00",
"date_create": "2025-11-22T09:18:29.329106+00:00",
"date_update": "2025-11-22T09:18:29.329106+00:00",
"date_closed": "2025-11-22T09:18:29.329106+00:00",
"suggested_user_id": "05476294-139d-40df-bd41-2bee4e34137b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5ef2a58-f1cd-49d2-895c-4d08f3888c01",
"db_language_id": "5e4f7452-37c0-408f-aeb3-e4e989a30ccc",
"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-11-22T09:18:29.329106+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eaf12722-c88b-440f-9a6f-0cc7da598c25",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "903dca76-8818-4ab0-a969-57ad32956bc6",
"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": "e8f38f74-06fe-401d-a8c8-414b7ddc5278",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "521937f7-ba8a-4a93-b470-9fe8fde2550c"
},
"suggested_date_start": "2025-11-22T09:18:29.329106+00:00",
"skill_id": "7147fb97-e9a4-4ab5-938a-c2abfa5aad06",
"skill_code": "sample string 32",
"skill": {
"id": "08d67abf-6c05-415a-880e-f96c744bb16d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c6c16678-f539-42da-a675-7344f317cf75",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "218406dc-e8c9-4018-8e58-8f88c13ccbfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2870f774-4723-4e71-b5f5-fa369ae2fd03",
"db_currency_id": "be5727ba-eb18-44c7-8105-601fae5e268b",
"db_language_id": "76e1c616-0e56-4a64-a6f2-c92c01f9bb42",
"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-11-22T09:18:29.3134837+00:00"
},
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9013a958-27e6-4968-b351-e07b8aedcac8",
"date_reported_by_company": "2025-11-22T09:18:29.329106+00:00",
"id2": 36,
"company_id": "748aadf1-5eb0-4544-a9ef-c0dfa5aad205",
"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": "3cb65bad-aa3f-401e-91ff-bec5827872a5",
"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-11-22T09:18:29.329106+00:00"
},
"work_instruction_details_id": "ad0779c3-4410-442e-bee6-cd5094dc2f5b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4ef572bd-e7e3-4667-aa72-1fd42991f938",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a0c31951-7029-4ae6-9114-00b9ac0111a5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T09:18:29.329106+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": "80d97ab4-7bca-41a1-b128-4ee6a0a056fe",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T09:18:29.329106+00:00"
}