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": "26eda77f-c8da-4997-a201-77feca2f982d",
"jobs_id": "05cf30ab-3233-4c52-bf5c-afd75eabe5e7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0427e756-7c5a-41c4-be58-91cf46a77680",
"_parent_id": "d3d99b35-6095-4497-972d-c80096bd9ea7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9e9fd16f-6a8d-4ec4-9014-2897bbb1226b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "be22ce3e-9219-4883-8968-05058efbb515",
"_parent_id": "f6cbb7ee-8b7e-4cc7-b0bb-2820e28c09c9",
"root_parent_id": "63692e6e-8bd9-44d3-a3c2-ac79fca91d68",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f4c5b352-a911-446b-91b3-c29dd65d3fb9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4589c6ea-2e71-4b67-8787-4139635cce55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ce7f24c-620d-4c54-a3cc-efd625c82b6b",
"_parent_code": "sample string 6",
"sales_organization_id": "8248efe5-0b20-4ff1-81a2-869f998ceff7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"equipment_model_id": "4fe3bd74-a120-46a9-8fe8-285c3c277eea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bc2e5314-c4e8-4935-a682-7a75615109a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "af5318cc-5cf9-4b73-8d7e-5723ce0d3772",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b5d6626d-171f-4d01-8e37-46a53954d9f8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "72e7a1a0-1b77-4bd1-9c38-b8207131c1f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"equipment_family_id": "2baece00-9149-4f9f-ad39-bc197382f3f3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4589c6ea-2e71-4b67-8787-4139635cce55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ce7f24c-620d-4c54-a3cc-efd625c82b6b",
"_parent_code": "sample string 6",
"sales_organization_id": "8248efe5-0b20-4ff1-81a2-869f998ceff7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"date_in_production_since": "2025-01-22T01:23:24.1842861+00:00",
"date_out_of_production_since": "2025-01-22T01:23:24.1842861+00:00",
"date_end_support": "2025-01-22T01:23:24.1842861+00:00",
"sales_organization_id": "59693f79-51db-472f-9192-e30a66271a80",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+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-01-22T01:23:24.1842861+00:00"
},
"project_status_id": "3de5325a-5bb2-49d9-937f-d54f939fc1c3",
"project_status_code": "sample string 10",
"project_status": {
"id": "fd74733a-f2e9-4ee1-9bc5-3135e87f0c8f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c508d462-8b4a-4dbe-8683-5ad88d0d9d8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"company_id": "9d6d9f83-1645-4eac-afdd-d84558484920",
"company_code": "sample string 12",
"db_address_id": "cbedd4a1-1a6e-4251-b0ef-42b233f1ea81",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a82db57c-cc9a-441b-b71e-6b59cea5a408",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a9c7751f-9043-4f74-a1dd-ef924e6e5f5e",
"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-01-22T01:23:24.1842861+00:00",
"date_create": "2025-01-22T01:23:24.1842861+00:00",
"date_update": "2025-01-22T01:23:24.1842861+00:00",
"updated_by_user_id": "ff16d688-df84-46d5-9725-2e0ff2cf5aaf",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-01-22T01:23:24.1842861+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-01-22T01:23:24.1842861+00:00",
"date_last_job": "2025-01-22T01:23:24.1842861+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-01-22T01:23:24.1842861+00:00",
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00",
"is_mobile_installation": true
},
"job_type_id": "79bb00c8-d703-4710-bc1a-d7d8322e54c1",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ca4e29f-6717-422a-9127-99fb296f3037",
"name": "sample string 2",
"sales_organization_id": "0418d344-5602-43ed-8509-690f126c5bc4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00",
"code": "sample string 7"
},
"job_priority_id": "106b5839-62f2-4149-a251-fab0dd31dd37",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "94d5d2ad-dbe2-483f-8881-0fb32ca2995e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dab3bc0f-c661-4629-8bbd-84389cfd357f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"job_status_id": "6e7f0ebf-a8d7-49ea-a77b-ad785c96916e",
"job_status_code": "sample string 11",
"db_address_id": "6be5b7c7-4018-4a6a-b63d-9d54bb6d9d0c",
"contact_id": "1285307f-2d3f-4598-972c-fef19dabd8fa",
"requested_by_company_id": "91ce78d6-ccc4-4634-9320-032a78c29dc5",
"requested_by_contact_id": "b510234b-dd8e-4a0c-b01f-019e31711a0c",
"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-01-22T01:23:24.1842861+00:00",
"due_date": "2025-01-22T01:23:24.1842861+00:00",
"date_create": "2025-01-22T01:23:24.1842861+00:00",
"date_update": "2025-01-22T01:23:24.1842861+00:00",
"date_closed": "2025-01-22T01:23:24.1842861+00:00",
"suggested_user_id": "1bedff23-d444-4f2d-a6d4-b9b955b1ab71",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b5dbeb21-9f83-4111-a56c-f9cd691e7c21",
"db_language_id": "d8dd752c-243a-4427-abeb-01d1f203bc08",
"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-01-22T01:23:24.1842861+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c1def82-aa4b-4f52-bfaa-a59bbd4302dd",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a9d29c3-171c-41e3-adff-34c9f1fb62f0",
"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": "f5d861be-db5d-4c76-860d-7ecdbc4c44d6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ff35c27e-ba8a-4993-9af7-52c75199a4ed"
},
"suggested_date_start": "2025-01-22T01:23:24.1842861+00:00",
"skill_id": "0679cfb2-adda-4f1e-8678-c04ce2767809",
"skill_code": "sample string 32",
"skill": {
"id": "b09bb45f-0291-4db7-9326-b1800557660e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7b676e39-0256-4ae8-8415-09229abf6f04",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "757d69cc-a441-44ec-b985-d9ab12fe4617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9917122-739f-40e5-9ad4-9c8ccdd8cb62",
"db_currency_id": "742d7fc2-f83f-448a-9880-d84b37c6a2fd",
"db_language_id": "495ee6d6-da34-4eb4-94d3-bd5accee01b9",
"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-01-22T01:23:24.1842861+00:00"
},
"modified_dateutc": "2025-01-22T01:23:24.1842861+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1bc3d6ff-faa2-44d8-bcbc-2f95a51f0979",
"date_reported_by_company": "2025-01-22T01:23:24.1842861+00:00",
"id2": 36,
"company_id": "288fb6be-54e9-4333-8d3b-5ded44e10cb2",
"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": "004d833a-d1d8-4942-996b-6f086c6d8522",
"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-01-22T01:23:24.1842861+00:00"
},
"work_instruction_details_id": "8c1d61f6-2a22-438c-9816-8f39660b31b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "83105405-f1b6-4f31-9f58-c96f2d744360",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cd9fd02a-e893-4e7d-8c70-f1b086ae3987",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-01-22T01:23:24.1842861+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": "6fc62dc7-90cb-40c3-b841-7f97b67639fe",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-01-22T01:23:24.1998986+00:00"
}