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": "65fac496-59ff-4477-8e9a-41904306a796",
"jobs_id": "1504b46b-fc88-467c-8580-fe5ff767555f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f6b35fa1-0ad2-46b1-93b7-0428d16dbea0",
"_parent_id": "c9f32004-4a5e-4a40-a117-229ad2289a58",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b27dd8ab-3572-4ec3-93cc-ef72429c22ee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "49298b83-218c-483a-bd14-90eb61f63720",
"_parent_id": "cb3c0ae9-c3a4-456b-bb49-085a82d67ad6",
"root_parent_id": "d2f38e2d-c058-4aca-b443-3dce5d5ab40b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ff6211ea-31f5-4c89-8f93-79b36d2852ea",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "261aac8b-0506-434c-a58e-13e295f4a0d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ca273cd4-d35e-40ac-897f-f12a5605333b",
"_parent_code": "sample string 6",
"sales_organization_id": "e349fe3f-7811-4122-b7be-b5ede02cb058",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"equipment_model_id": "4be33d10-ca71-45d6-aee6-63684896f46a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5a3a7533-35f5-4b4f-8a2a-0401e16a0e62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "109d6431-e68e-4059-b3b0-436e196f583c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c9acf1f7-ef8f-43dc-a071-2d7f1cbffa5b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "402220ec-6861-4b80-a0fc-fd9db9f04b54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"equipment_family_id": "0dcc69fc-f16e-446b-aeae-b906ad2a3c9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "261aac8b-0506-434c-a58e-13e295f4a0d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ca273cd4-d35e-40ac-897f-f12a5605333b",
"_parent_code": "sample string 6",
"sales_organization_id": "e349fe3f-7811-4122-b7be-b5ede02cb058",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"date_in_production_since": "2026-09-07T11:23:13.0303671+00:00",
"date_out_of_production_since": "2026-09-07T11:23:13.0303671+00:00",
"date_end_support": "2026-09-07T11:23:13.0303671+00:00",
"sales_organization_id": "dc968c3a-9884-4794-a767-66f9d34cdb60",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+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-07T11:23:13.0303671+00:00"
},
"project_status_id": "33abcf42-9f82-4fcb-a08d-8370bf96b972",
"project_status_code": "sample string 10",
"project_status": {
"id": "ff0a1544-48b4-4f0d-869a-639b31f1796c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e8f4db0c-943f-40b4-b04a-e9a2add2fdac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"company_id": "db287092-0bb7-4d1a-b69a-85cc609f071c",
"company_code": "sample string 12",
"db_address_id": "27f694e0-d9a3-43a1-ab2e-9c6fde5c9826",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6cb47754-1bc0-4805-b5df-1fb51c63caaa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "535d7229-bd1d-4b93-8a4d-3571c61783f5",
"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-07T11:23:13.0303671+00:00",
"date_create": "2026-09-07T11:23:13.0303671+00:00",
"date_update": "2026-09-07T11:23:13.0303671+00:00",
"updated_by_user_id": "7c549642-a87c-4492-9eda-4374d960b970",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T11:23:13.0303671+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T11:23:13.0303671+00:00",
"date_last_job": "2026-09-07T11:23:13.0303671+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T11:23:13.0303671+00:00",
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00",
"is_mobile_installation": true
},
"job_type_id": "dd1fb8c6-8b3e-4d89-ad74-93ce61e406b7",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f5a50c5-2310-48d1-8d7c-8322ac4b61f2",
"name": "sample string 2",
"sales_organization_id": "22001c96-429c-48be-87e4-6556e68314c4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00",
"code": "sample string 7"
},
"job_priority_id": "96109212-2c50-4893-870f-60591a681b4e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c0dcfb90-0970-4213-9df0-d730775a85fc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2584ceb4-ae83-424d-87cd-285f9a37f7b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"job_status_id": "6685be3c-9e47-43b9-8d0e-96aa8181c855",
"job_status_code": "sample string 11",
"db_address_id": "0d5287fb-9f91-4c32-894d-e022df892513",
"contact_id": "69153f30-28c1-4ba9-b6b3-d77c7e43a3f3",
"requested_by_company_id": "6b104fea-9840-42f3-a807-a3b34c0810a1",
"requested_by_contact_id": "ae255d13-fe59-405a-afbc-d75c677f6ff9",
"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-07T11:23:13.0303671+00:00",
"due_date": "2026-09-07T11:23:13.0303671+00:00",
"date_create": "2026-09-07T11:23:13.0303671+00:00",
"date_update": "2026-09-07T11:23:13.0303671+00:00",
"date_closed": "2026-09-07T11:23:13.0303671+00:00",
"suggested_user_id": "2065e5e7-68dd-460a-98fc-f7a3c02ce176",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6fff0b2c-4798-4be4-9604-1b6d390f8854",
"db_language_id": "f473d713-6d79-49b4-bc83-4e38d5042bdd",
"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-07T11:23:13.0303671+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b53b5d90-24bb-4623-a9ad-d25b6aebcef1",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f9e92ed1-ac9d-4d85-b677-21c488ddf42e",
"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": "4c8a8e13-262b-40c2-a25c-3e24aa38a9d7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "097fb15d-8377-46f6-b38d-10139702c163"
},
"suggested_date_start": "2026-09-07T11:23:13.0303671+00:00",
"skill_id": "6c90760f-02fb-417a-8e91-600399c8b0a1",
"skill_code": "sample string 32",
"skill": {
"id": "3e3080a6-4d14-4a8f-b46f-63b1b92a91f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0bada98b-5c71-4a51-985e-23bd36632382",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56fdd981-b349-409e-a9b0-e0d24569797e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bba70c5-dd09-41e2-aa08-7b23c1737e25",
"db_currency_id": "e52d97e6-a051-49a2-818a-c7dd59a75261",
"db_language_id": "049f97ff-e1a6-4470-9302-6e1dcd357c32",
"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-07T11:23:13.0303671+00:00"
},
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "61fb7bf7-5e39-4d78-870a-907466619de1",
"date_reported_by_company": "2026-09-07T11:23:13.0303671+00:00",
"id2": 36,
"company_id": "367b0637-ccc0-4fac-8bec-67626e34f67a",
"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": "7d9339e0-9295-4a66-92b6-edc436ea4df1",
"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-07T11:23:13.0303671+00:00"
},
"work_instruction_details_id": "9bf0dea2-3c86-4caf-bc92-b826d1a0a1ef",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5954a895-10b6-4d66-aefc-a91c5cb754b4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "08685b35-b955-4b66-8c2a-ccc805d4a2f4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T11:23:13.0303671+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": "e6c0b38b-017a-402a-b389-e4e11db7fc18",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T11:23:13.0303671+00:00"
}