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": "db27f043-011c-43e0-a6f6-1f1b064da87a",
"jobs_id": "ecc9a302-cb22-4ab9-b7a9-93d0578b9e70",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "50ecfe7e-5159-4ce1-98b0-7c90c87a71ba",
"_parent_id": "f32a57ad-a5bd-4a7d-a78b-d838c4d2576e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "848dd4e4-4d54-4d1c-a3bb-c15f249e1f54",
"project_reference_back_office": "sample string 5",
"project": {
"id": "760915fa-eedb-4bfe-b0d4-b8f96aac0cf9",
"_parent_id": "acf9e567-8dfa-44e1-b4cf-7d2df3a20ef9",
"root_parent_id": "2b454857-4c34-4fd3-b877-431b96da1804",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5a2912b6-60c3-463b-8f2d-6d81a95aaded",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6f139303-3f7a-4912-8a20-23d6dbacedb6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4689deaf-fff9-49b9-b414-12b46a660c06",
"_parent_code": "sample string 6",
"sales_organization_id": "cd4c9749-159a-4895-806e-25779ed85879",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"modified_dateutc": "2026-01-07T06:19:33.4662953+00:00"
},
"equipment_model_id": "4da3cb40-20c0-4d77-bced-8865c649c21b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c0590a21-ae20-4814-ae89-10b2123f17e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "60012cb8-5c81-4cfb-b3f3-c7b2aa1d3825",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1b95a2c8-436a-47ac-be8b-13bdc19ac580",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c51a536c-df9a-49fe-9acd-5456bc2c18f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00"
},
"equipment_family_id": "a586bb47-7b17-428f-9f69-8cf739e0f570",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6f139303-3f7a-4912-8a20-23d6dbacedb6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4689deaf-fff9-49b9-b414-12b46a660c06",
"_parent_code": "sample string 6",
"sales_organization_id": "cd4c9749-159a-4895-806e-25779ed85879",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"modified_dateutc": "2026-01-07T06:19:33.4662953+00:00"
},
"date_in_production_since": "2026-01-07T06:19:33.4819195+00:00",
"date_out_of_production_since": "2026-01-07T06:19:33.4819195+00:00",
"date_end_support": "2026-01-07T06:19:33.4819195+00:00",
"sales_organization_id": "cf742bf1-d1cc-4326-9549-69bfa190af54",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+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-01-07T06:19:33.4819195+00:00"
},
"project_status_id": "05b81e4a-52ae-4f1c-bb6c-2d17884f6be6",
"project_status_code": "sample string 10",
"project_status": {
"id": "922ba7fb-c356-4673-b37b-f39e62b0c0cf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8cf022fa-1045-4d7c-ae54-4c5a0f06db24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00"
},
"company_id": "74786b30-8d40-4974-a092-fd45aec9a4ec",
"company_code": "sample string 12",
"db_address_id": "7a2fb5da-7b46-469a-a8bb-f324e2a83954",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "89e31f13-2075-4658-8c5e-6d745ba27cb5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9152121e-0d3c-4cb0-aee2-67653aa745cb",
"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-01-07T06:19:33.4819195+00:00",
"date_create": "2026-01-07T06:19:33.4819195+00:00",
"date_update": "2026-01-07T06:19:33.4819195+00:00",
"updated_by_user_id": "ba413467-fc71-41e6-826c-04bffc9d2f64",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T06:19:33.4819195+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T06:19:33.4819195+00:00",
"date_last_job": "2026-01-07T06:19:33.4819195+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T06:19:33.4819195+00:00",
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00",
"is_mobile_installation": true
},
"job_type_id": "bbc99397-72a2-49e7-ac22-dededd8ea3bd",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ab5fe79-195f-4c75-8735-5108989a991f",
"name": "sample string 2",
"sales_organization_id": "96f390b9-e9a7-4655-bce3-8c26986ee556",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00",
"code": "sample string 7"
},
"job_priority_id": "190b0af7-b204-4ae7-ac57-7da7588aa2d8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b36acd3e-d050-4756-afb5-0af3c8e664e5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1809cba9-f122-41bc-a098-edf2af0b01ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00"
},
"job_status_id": "2a7299f2-8470-437f-9d17-3e785a74702a",
"job_status_code": "sample string 11",
"db_address_id": "cfeb344e-671a-4710-a87d-5eaf2f0ad05e",
"contact_id": "1618b14e-7768-4cea-b708-a8f1c9d0bc65",
"requested_by_company_id": "64a85bb6-741b-4edc-a7bf-dfa58a91f763",
"requested_by_contact_id": "71520b1e-006a-4e39-8763-ed6de04a2452",
"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-01-07T06:19:33.4819195+00:00",
"due_date": "2026-01-07T06:19:33.4819195+00:00",
"date_create": "2026-01-07T06:19:33.4819195+00:00",
"date_update": "2026-01-07T06:19:33.4819195+00:00",
"date_closed": "2026-01-07T06:19:33.4819195+00:00",
"suggested_user_id": "ba824f12-0772-4a87-abc1-42660fc46153",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a16a7b63-0915-4d81-810c-5c3b5914268c",
"db_language_id": "1b5090b9-f35a-43fa-9d85-f08fdaddb84a",
"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-01-07T06:19:33.4819195+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4e6a2011-81f6-4502-9417-599d2d6fcb46",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cce823d9-d322-4b07-b023-5164c4373fa6",
"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": "8c80e873-8eab-4e04-a57a-a71b4d68cf8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1565eb16-06f4-4d77-afb7-c8fd82e701ee"
},
"suggested_date_start": "2026-01-07T06:19:33.4819195+00:00",
"skill_id": "6f3dbb60-683c-4e99-9248-a19cfb6652db",
"skill_code": "sample string 32",
"skill": {
"id": "8ea91f08-3968-4032-aee3-2fe844124cad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4c1d985c-835f-4b54-af75-9b852aee644a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7ae8dd-d969-4bcb-af45-ce35ea2a6e67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55b42267-9ac4-4db1-9c7a-9f8fb383ba91",
"db_currency_id": "98029ce3-4727-47c0-b408-dd5e7f84c977",
"db_language_id": "4b9dde35-8199-4cd0-acdf-95257bc8f6d1",
"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-01-07T06:19:33.4662953+00:00"
},
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a477c24c-b8b8-4745-92a7-23b70c699015",
"date_reported_by_company": "2026-01-07T06:19:33.4819195+00:00",
"id2": 36,
"company_id": "f9f4cf00-e818-4211-9867-d0813ed628ed",
"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": "d4fc4963-1468-4844-93d2-fb7b30afa688",
"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-01-07T06:19:33.4819195+00:00"
},
"work_instruction_details_id": "95db85e4-a6fe-4cf9-a127-7c234ad25091",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dda58ecc-75cf-41b0-a7f4-7a9d8c359f55",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27f6039b-8c56-4299-ad76-e58b544ad34f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T06:19:33.4819195+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": "67250107-a2b2-4e3c-840d-3c254e2fa735",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T06:19:33.4819195+00:00"
}