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": "5775ff7d-4f09-4301-a6f1-6aa0633ccb35",
"jobs_id": "43488def-561a-4fa4-aca6-87132e2836e1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5b2f0a53-9cad-4b75-a401-3371a9427c53",
"_parent_id": "ffcaab12-f43b-414d-ac33-282a755ae510",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "158e739a-f0b5-466d-afbc-69d1c13195ea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f1ad64b3-5caa-4f8f-8580-e32d71a54faa",
"_parent_id": "7727ca5c-97cf-4326-935b-d1c696adc203",
"root_parent_id": "86dc97ff-e990-4bd6-aa6e-7529734bc550",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6079b705-c21c-4636-89ae-64a35d96653b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c2711f30-2917-4339-aa6d-ba1c940b3891",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "54543021-d915-46f8-9a3a-0bdf205434c5",
"_parent_code": "sample string 6",
"sales_organization_id": "795e37c5-e0af-4956-9cf8-3e3f1faeacea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"equipment_model_id": "069a637a-91a3-4c85-b0e5-d84e4b24449b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "de14ed7f-26b9-4565-afc1-0dd3a513a38a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8e4f94df-c6ca-4297-8489-0cdcbc044074",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e18c1d4c-6dbb-4369-8000-3f44575e4774",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "66b0ae32-9893-41d6-9007-314478c0b2c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"equipment_family_id": "e0fbcb80-5bae-4354-b5fe-56c20add5d96",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c2711f30-2917-4339-aa6d-ba1c940b3891",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "54543021-d915-46f8-9a3a-0bdf205434c5",
"_parent_code": "sample string 6",
"sales_organization_id": "795e37c5-e0af-4956-9cf8-3e3f1faeacea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"date_in_production_since": "2025-12-30T11:05:28.6511542+00:00",
"date_out_of_production_since": "2025-12-30T11:05:28.6511542+00:00",
"date_end_support": "2025-12-30T11:05:28.6511542+00:00",
"sales_organization_id": "0655df05-ba5e-40e5-a90f-7a990974fbb8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+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-12-30T11:05:28.6511542+00:00"
},
"project_status_id": "c97c8e1a-4d9b-4d51-b8b6-8ffa2d1bd8bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "c892980f-ab5a-44aa-8d67-348f0062d313",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "858609e8-0325-42a3-a005-3deaaa0cb14d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"company_id": "8569df44-fcb4-42db-bebd-42980779e117",
"company_code": "sample string 12",
"db_address_id": "c2adbffe-1639-4dba-81fa-723faed714da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0cedae9c-be6a-4a73-b5a3-1694634f7467",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "224cad78-d9c5-4ef4-ab97-efcf99e81f37",
"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-12-30T11:05:28.6511542+00:00",
"date_create": "2025-12-30T11:05:28.6511542+00:00",
"date_update": "2025-12-30T11:05:28.6511542+00:00",
"updated_by_user_id": "dfac321b-2d9e-4f98-a60c-9c09e07d595b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-30T11:05:28.6511542+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-12-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-30T11:05:28.6511542+00:00",
"date_last_job": "2025-12-30T11:05:28.6511542+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-30T11:05:28.6511542+00:00",
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00",
"is_mobile_installation": true
},
"job_type_id": "5ac2742a-193c-4486-8a79-d6eae3083e11",
"job_type_code": "sample string 7",
"job_type": {
"id": "827a3c99-511a-4396-a9db-954784dbf911",
"name": "sample string 2",
"sales_organization_id": "919dda86-8acc-402b-8da3-ca5e7556a2ba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00",
"code": "sample string 7"
},
"job_priority_id": "cb8108ff-97c0-49d9-8186-27118b9a4571",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0217c395-2c8f-4356-969f-0ca6dd5c1144",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f53dded5-646e-420a-ae5c-f11d66857075",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"job_status_id": "c8d89c36-0584-476f-b0b6-c9bb033e48a2",
"job_status_code": "sample string 11",
"db_address_id": "8e41a819-7615-4d97-9765-63877c2b38d2",
"contact_id": "baab9bbb-836f-442e-bbd2-bbfad8ec6351",
"requested_by_company_id": "4627d773-8bcc-4837-8f04-adaa217a0b2e",
"requested_by_contact_id": "238c2371-3c7f-4a97-b490-e0b7fe03d69f",
"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-12-30T11:05:28.6511542+00:00",
"due_date": "2025-12-30T11:05:28.6511542+00:00",
"date_create": "2025-12-30T11:05:28.6511542+00:00",
"date_update": "2025-12-30T11:05:28.6511542+00:00",
"date_closed": "2025-12-30T11:05:28.6511542+00:00",
"suggested_user_id": "8a65c289-b0cf-41df-8218-59165e7b6c35",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "39fe342b-7300-47d6-8c08-391271114715",
"db_language_id": "3c7c0113-e9dd-4b47-869f-b2ed50ac2dae",
"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-12-30T11:05:28.6511542+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8a4277eb-010f-47e2-b3cd-d969fedfeaa9",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "271768f7-7e50-4faf-8db7-e3ec7eb07d34",
"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": "afb4df66-627e-4693-82c3-c3f2df214f22",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8a2541ef-cb27-4f7b-ad37-6f7f5aa979db"
},
"suggested_date_start": "2025-12-30T11:05:28.6511542+00:00",
"skill_id": "2bae9dcc-6d97-4c8f-a563-0e9578d14d98",
"skill_code": "sample string 32",
"skill": {
"id": "08d55099-4687-4184-8b27-9a71a49be7fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff80a735-728c-4e5c-9612-edd9869f54ce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b6b0090-45ab-4cd1-bbcd-7e77c8b22935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "879cd5b8-7ce6-4edd-8493-14b89a4705ca",
"db_currency_id": "2a2ef577-873e-4810-9638-ddbf7daa7c94",
"db_language_id": "205da398-d734-41a0-80f8-96f7f1510dde",
"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-12-30T11:05:28.6511542+00:00"
},
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d0cb0446-7663-42ae-b01b-c75169ef5998",
"date_reported_by_company": "2025-12-30T11:05:28.6511542+00:00",
"id2": 36,
"company_id": "68dc626f-2252-4618-bead-7e71953d1e6d",
"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": "70e898da-11da-44ec-bc11-c77c28f70750",
"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-12-30T11:05:28.6511542+00:00"
},
"work_instruction_details_id": "732fdc55-a663-45a7-8209-01c3e0811f0b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "24973844-1f9c-4681-9a4f-5d1478a9122e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2836f466-c71d-404a-9329-9ef0e0e6d0bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-30T11:05:28.6511542+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": "0da6b2a7-761f-4293-bcfc-9ac060b2ef2c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-30T11:05:28.6511542+00:00"
}