Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "fd369872-fbfb-4a4e-bf25-2ce47b88c32d",
"jobs_id": "32b5f4af-a9b0-47cf-94d0-1b3a0e228391",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "389cad6e-9139-4aca-a0f0-0947b6a3cdd4",
"_parent_id": "35ef892a-7b87-4ac6-884c-82bb45a83d48",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf42e80f-6d15-46f1-b556-5a90c7e32bea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b7850964-c5c6-4567-9c0f-5e8bf75db089",
"_parent_id": "585370b8-8904-4bf3-b107-09abbc752f14",
"root_parent_id": "812b08fc-afdf-4dae-a72c-a7c7d3d29eb9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0da93391-a7fe-4c7f-b72a-95779055b644",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f233417d-e7c4-42be-be08-922cec5d20b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89837e47-52ef-4473-883c-55885acdde85",
"_parent_code": "sample string 6",
"sales_organization_id": "ffdb9c36-d056-49a1-8422-8ba426d40674",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"equipment_model_id": "8c1b5e52-e546-4c00-b2cc-b2b184ae58ee",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "acfc14b3-9f49-44a9-8a9e-3c3e3cfbe161",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "07c4050d-1a73-4137-830d-7151c0ceb890",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a655b897-7f2d-4402-8469-b65ab07254d4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bf329f45-8067-4f2a-985f-dbc2ba840634",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"equipment_family_id": "da7c4c65-b5ce-4487-aeab-e78755e62c42",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f233417d-e7c4-42be-be08-922cec5d20b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89837e47-52ef-4473-883c-55885acdde85",
"_parent_code": "sample string 6",
"sales_organization_id": "ffdb9c36-d056-49a1-8422-8ba426d40674",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"date_in_production_since": "2026-06-02T03:49:44.6588828+00:00",
"date_out_of_production_since": "2026-06-02T03:49:44.6588828+00:00",
"date_end_support": "2026-06-02T03:49:44.6588828+00:00",
"sales_organization_id": "11aea892-d6b7-4879-a8bd-8c8905265c58",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+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-06-02T03:49:44.6588828+00:00"
},
"project_status_id": "3315d0e5-f7bd-4afc-865a-43680f02b9d0",
"project_status_code": "sample string 10",
"project_status": {
"id": "58cc76db-e831-4fc5-a20a-dfc3efbded02",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "13d7fb37-9787-4eaa-88bf-74a9cf010eb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"company_id": "d9e25eb6-497d-434c-9df3-afd0fb5b72c7",
"company_code": "sample string 12",
"db_address_id": "6bf35910-a46f-4cb2-bd11-55c4d1e76536",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5fb61f72-8a79-4726-9f96-906278023f03",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "16305465-be3e-4863-85ec-9c04afe28cee",
"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-06-02T03:49:44.6588828+00:00",
"date_create": "2026-06-02T03:49:44.6588828+00:00",
"date_update": "2026-06-02T03:49:44.6588828+00:00",
"updated_by_user_id": "f6d74e24-11e5-4cd7-8bb2-8aeddfc5e247",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:49:44.6588828+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:49:44.6588828+00:00",
"date_last_job": "2026-06-02T03:49:44.6588828+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:49:44.6588828+00:00",
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00",
"is_mobile_installation": true
},
"job_type_id": "9fef2ae3-a33e-459b-af1e-1c0142cf0e47",
"job_type_code": "sample string 7",
"job_type": {
"id": "3d76c301-fa85-4d5e-a3e7-50b8a59c0933",
"name": "sample string 2",
"sales_organization_id": "394b515c-fa95-4709-8504-ff8c1c0f8e9d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00",
"code": "sample string 7"
},
"job_priority_id": "3d9e3f7e-477e-425c-944f-a0a2fd35e922",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "577124a6-aee1-4c77-93f9-45eac946e342",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "22c17d60-674e-47fe-8958-ed761c55f4a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"job_status_id": "9837c192-b0ae-480d-ae3e-32fa5ff64354",
"job_status_code": "sample string 11",
"db_address_id": "bd0bd2db-68e1-4b71-b0c3-e969f7b3fcb9",
"contact_id": "93c37206-a0b3-4b0b-876d-3079483245be",
"requested_by_company_id": "60d0b829-ece8-469f-9cd8-e767593d0c23",
"requested_by_contact_id": "1d8a96e9-d6db-47a3-a6c0-5b614e4d1a13",
"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-06-02T03:49:44.6588828+00:00",
"due_date": "2026-06-02T03:49:44.6588828+00:00",
"date_create": "2026-06-02T03:49:44.6588828+00:00",
"date_update": "2026-06-02T03:49:44.6588828+00:00",
"date_closed": "2026-06-02T03:49:44.6588828+00:00",
"suggested_user_id": "39dd093d-d429-4252-9e7e-e0a9a08d1ecd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eb97bf9e-f57e-4d2a-82fa-b7cc9eb62d59",
"db_language_id": "890d1287-7af1-4b72-8600-a8fbfd179d96",
"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-06-02T03:49:44.6588828+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2e791cda-ee2a-4491-8ea9-a4ccf0cac3f0",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c094dd43-6216-4ff8-9a63-9e56eff80b06",
"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": "9bc1fb4d-3b4a-4d54-ae6d-dcdf5a3efbb4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f13c2449-0b54-40eb-8cb7-9c5fb07a733b"
},
"suggested_date_start": "2026-06-02T03:49:44.6588828+00:00",
"skill_id": "e607cbd5-be61-4a88-a2de-707639ad251e",
"skill_code": "sample string 32",
"skill": {
"id": "a0fc0499-2d07-4511-aff3-2822884a84db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c7603847-43f1-44cd-b149-a000147ee3cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "580c70c9-7e27-4623-9117-fe01430966db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "979595d0-67a1-40ad-8e37-a6ead784cadf",
"db_currency_id": "f995ca59-e651-42a9-8898-c28ac12d21bc",
"db_language_id": "1c3e81c6-fd7b-4df4-9b5b-a70fc1300d91",
"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-06-02T03:49:44.6588828+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b76d0a37-8822-4aea-a273-212cd39ae91a",
"date_reported_by_company": "2026-06-02T03:49:44.6588828+00:00",
"id2": 36,
"company_id": "a952c50c-0427-4f9a-b7a5-1a2feb4ffe7b",
"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": "345f2296-8adc-40a4-92b2-0f76a6fde3cd",
"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-06-02T03:49:44.6588828+00:00"
},
"work_instruction_details_id": "1360acbd-1df9-4194-bbaf-93dc167d0fe8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4d6eeb9e-4ce8-4f31-a6ca-80bc35810cee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29244e28-f604-42cd-a1ab-ff99265ad789",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:49:44.6588828+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": "29c3f26e-906e-46f9-a3bf-378628102890",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:49:44.6588828+00:00"
}