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": "4e8df3e6-e16c-45f5-8da4-2aa0a2fe6421",
"jobs_id": "295da601-7d86-4032-845d-c8adafef5677",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "810a49bf-6932-4ca3-8539-44fff1c7b16f",
"_parent_id": "038ecb78-2cef-429a-9738-4ed518317b56",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "51f14801-4ec8-4484-a84d-80ff0b41d162",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d42b4d48-fa52-4e56-a808-4b5dff438d9a",
"_parent_id": "ad8b03d8-4007-4855-bc56-db7d3cbdc4c0",
"root_parent_id": "65c9695d-e76f-4f75-89eb-79239e8b4e2d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76d16baa-dc0a-4217-8e4a-80e6ea5992cb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "887bc834-0a03-4a74-91fa-e6207fd45a01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6d263d90-7888-4f41-b6c6-7f3fdf74026a",
"_parent_code": "sample string 6",
"sales_organization_id": "a5e2376d-b0b9-45e2-880b-f8d16deb44b0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00"
},
"equipment_model_id": "4378bb0a-ed62-48df-a51b-76f24c3cc122",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e5b9c36-9a3b-4b0b-a5e7-d415653b7da9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5d01b93d-4e19-4850-a9ee-05540c0587c2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f1ad88cd-0f07-41c3-9fd1-3f3ae6e29c7d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1b518212-6878-4a3c-8a3e-08c8889125ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00"
},
"equipment_family_id": "5e205899-e23b-461b-a83f-455a8d5a66c6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "887bc834-0a03-4a74-91fa-e6207fd45a01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6d263d90-7888-4f41-b6c6-7f3fdf74026a",
"_parent_code": "sample string 6",
"sales_organization_id": "a5e2376d-b0b9-45e2-880b-f8d16deb44b0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00"
},
"date_in_production_since": "2026-09-04T05:58:49.0038087+00:00",
"date_out_of_production_since": "2026-09-04T05:58:49.0038087+00:00",
"date_end_support": "2026-09-04T05:58:49.0038087+00:00",
"sales_organization_id": "d3a74526-a564-49fb-b584-1ef3142c9f31",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+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-09-04T05:58:49.0038087+00:00"
},
"project_status_id": "82711470-2d54-425a-bd66-18942c21946e",
"project_status_code": "sample string 10",
"project_status": {
"id": "ce0db6a4-3ff9-4e20-803b-f0010c7828c6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b2a6b42f-735c-4445-b4a5-ff7b016c3821",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00"
},
"company_id": "c6764df6-ad15-4938-9f0a-248cfad38ab8",
"company_code": "sample string 12",
"db_address_id": "f28343ba-2711-4cf0-9bbb-2943d170f582",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc11a639-0592-45e8-ae2e-5907797902ac",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cf5d712b-6fa2-4eaa-9fef-2db2d96e0c09",
"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-09-04T05:58:49.0038087+00:00",
"date_create": "2026-09-04T05:58:49.0038087+00:00",
"date_update": "2026-09-04T05:58:49.0038087+00:00",
"updated_by_user_id": "db22e22e-0197-4345-b6b1-99ed218b62ee",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T05:58:49.0038087+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-09-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T05:58:49.0038087+00:00",
"date_last_job": "2026-09-04T05:58:49.0038087+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T05:58:49.0038087+00:00",
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00",
"is_mobile_installation": true
},
"job_type_id": "62fa2989-5827-4cea-a30f-59df87cde533",
"job_type_code": "sample string 7",
"job_type": {
"id": "aab4f955-b656-40b7-ac3b-92ede125542e",
"name": "sample string 2",
"sales_organization_id": "d5be6ee7-5b46-4d94-ba1b-7b322d74821c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T05:58:49.0038087+00:00",
"code": "sample string 7"
},
"job_priority_id": "aa307847-4d71-4ff7-9501-c457c9f6f003",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "df67df72-d1a1-4bdf-93a3-e03e100e2530",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "13a9c955-bb43-4c34-8068-609584891e5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T05:58:49.0194307+00:00"
},
"job_status_id": "cd5d6e04-4f31-4982-9dc8-a864d5996d6d",
"job_status_code": "sample string 11",
"db_address_id": "f257894d-5610-41ea-a20a-42666551988c",
"contact_id": "62fd0728-71b2-419d-a29d-8c91b4e3dc36",
"requested_by_company_id": "3cb1b4c3-c925-4d45-8abb-3fdc19dfd6fa",
"requested_by_contact_id": "99b95510-a67e-473d-9093-83443456141d",
"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-09-04T05:58:49.0194307+00:00",
"due_date": "2026-09-04T05:58:49.0194307+00:00",
"date_create": "2026-09-04T05:58:49.0194307+00:00",
"date_update": "2026-09-04T05:58:49.0194307+00:00",
"date_closed": "2026-09-04T05:58:49.0194307+00:00",
"suggested_user_id": "0827da1c-88d5-4abe-9b4c-3c55b9cee399",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a9b36a5e-884d-4f62-8df6-4aef6c2ed940",
"db_language_id": "9b0c8d7e-70de-4911-97a1-facd91606fea",
"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-09-04T05:58:49.0194307+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2dba0c75-efc4-41a5-be20-b9980ca072bb",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1046a7f1-6313-4de8-8848-fa6626cc7fb8",
"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": "ac93a706-5839-4686-aa94-9f1ba495a64b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T05:58:49.0194307+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d065222c-6be5-42e5-81f5-3ca055a815c8"
},
"suggested_date_start": "2026-09-04T05:58:49.0194307+00:00",
"skill_id": "d5ccdfa8-502f-481c-9dc0-d3d78f1ab294",
"skill_code": "sample string 32",
"skill": {
"id": "ae7119ae-5532-41d7-9e44-6727403bca61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "536e660d-8098-454b-9676-1e517485bf11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "36f1afb3-54c9-4897-a3f9-71a799fd6ae1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63bd6f09-fe14-42c8-aea6-1f0f5ce35c87",
"db_currency_id": "c5260f66-3a9e-441b-834f-0263d7cd05ce",
"db_language_id": "967b778e-83cb-4a33-a9de-792d827edad2",
"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-09-04T05:58:49.0038087+00:00"
},
"modified_dateutc": "2026-09-04T05:58:49.0194307+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77a0383a-ac21-4b34-b4d9-841b694047bc",
"date_reported_by_company": "2026-09-04T05:58:49.0194307+00:00",
"id2": 36,
"company_id": "f9860553-73a1-4492-a795-5cf214619b9e",
"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": "52d77051-6873-4fad-a665-bd25224adc61",
"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-09-04T05:58:49.0194307+00:00"
},
"work_instruction_details_id": "c9f6c47a-be05-4fa5-9207-b53bd767efe1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e2613127-76b8-430c-841e-b37024581162",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "52cc81f8-b663-406c-b03f-4ff17d6fb611",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T05:58:49.0194307+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": "5f95df54-a447-4af8-9157-14b1814af798",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T05:58:49.0194307+00:00"
}