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": "b556ed4d-3e89-4c4b-ab48-c5da7c4da7c9",
"jobs_id": "f2c7c8d8-a6b7-4c61-ab7c-27117ed51154",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ad467e44-ae12-498e-a357-4fc92c1288b4",
"_parent_id": "68058af1-0c6d-46b0-9d52-0fe6b840aff5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c78cdc48-8665-441d-b57e-e842c4b22bc8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "801d6c84-7f0e-4a81-a5ae-8e51d77a4e3c",
"_parent_id": "c3a573f4-ca02-4026-b025-3e7970a1d762",
"root_parent_id": "4ec2e8c4-79ea-47cd-9161-ea9bab692c07",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "32e6ccb4-42bc-409b-8090-adb8cb604cb3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8f88ae86-7fca-424e-a09f-97f010b37990",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e24cbfe9-d437-4c38-a8b1-31ea753fcc4a",
"_parent_code": "sample string 6",
"sales_organization_id": "343678c0-eba3-4d5b-9652-fa09e0a7796c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"equipment_model_id": "e3959029-c519-47c0-9926-19f7b2bebc13",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "991046f8-5cd3-44ea-9230-90900234824c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6594b924-4458-4c3c-b8f3-c03978ba91f8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8c2afdc-f312-4c64-ad1e-309916522657",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d3a51f67-9d0b-48d1-af2c-1aa4f69c233b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"equipment_family_id": "0a657440-2171-4e19-ae97-359b2b54e48e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8f88ae86-7fca-424e-a09f-97f010b37990",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e24cbfe9-d437-4c38-a8b1-31ea753fcc4a",
"_parent_code": "sample string 6",
"sales_organization_id": "343678c0-eba3-4d5b-9652-fa09e0a7796c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"date_in_production_since": "2024-11-21T08:52:28.6169965+00:00",
"date_out_of_production_since": "2024-11-21T08:52:28.6169965+00:00",
"date_end_support": "2024-11-21T08:52:28.6169965+00:00",
"sales_organization_id": "5cfc4126-97e5-4710-a65f-abaf21c9ee5d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+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": "2024-11-21T08:52:28.6169965+00:00"
},
"project_status_id": "ad8895de-c3fe-4669-bc94-189ae250ecc0",
"project_status_code": "sample string 10",
"project_status": {
"id": "71ebaa74-2d26-4ebd-bbfa-6619c7887967",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "69f81d1f-e1f3-46f8-a19e-73959bd024fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"company_id": "3c5d8f10-1ec3-4a8f-b12a-afd83c04ea03",
"company_code": "sample string 12",
"db_address_id": "0bda4155-5354-4a86-bfde-a9caf7e4da56",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "97a9ece6-1c4b-402a-92cc-1d65aa458790",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b37ab4ab-7fdb-4deb-9f1a-78d1ca226e90",
"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": "2024-11-21T08:52:28.6169965+00:00",
"date_create": "2024-11-21T08:52:28.6169965+00:00",
"date_update": "2024-11-21T08:52:28.6169965+00:00",
"updated_by_user_id": "ba628679-6606-4b1a-83da-22333cb88ff6",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-21T08:52:28.6169965+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": "2024-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-21T08:52:28.6169965+00:00",
"date_last_job": "2024-11-21T08:52:28.6169965+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-21T08:52:28.6169965+00:00",
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00",
"is_mobile_installation": true
},
"job_type_id": "e060a682-6456-4c9d-9a31-9c14433f31bb",
"job_type_code": "sample string 7",
"job_type": {
"id": "edbe2ffa-2518-4225-893b-b0cae0ad90f8",
"name": "sample string 2",
"sales_organization_id": "ff777c84-4dee-4766-8ac2-1fba131cb0e6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00",
"code": "sample string 7"
},
"job_priority_id": "1cabdf1f-a464-40c2-bcc4-73625d8320fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8acb62d2-202f-46ae-8258-8f6d01e22b5d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6ad6c365-61a4-497b-ab5f-ed5e8d7460f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"job_status_id": "9f183812-60c6-4a50-9e72-14ef30b5d255",
"job_status_code": "sample string 11",
"db_address_id": "1f2258b2-53e5-4fd5-90bc-223801993706",
"contact_id": "07e2eb09-0827-4050-b8c7-aaceeda26a03",
"requested_by_company_id": "325b0240-d6a9-417c-a3f6-3c59363b4496",
"requested_by_contact_id": "45e09442-2419-4960-ab65-277824ced946",
"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": "2024-11-21T08:52:28.6169965+00:00",
"due_date": "2024-11-21T08:52:28.6169965+00:00",
"date_create": "2024-11-21T08:52:28.6169965+00:00",
"date_update": "2024-11-21T08:52:28.6169965+00:00",
"date_closed": "2024-11-21T08:52:28.6169965+00:00",
"suggested_user_id": "16a63e13-cebd-46b2-a455-095ada9bcf7f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a00838e9-c163-4036-b0b7-f987f0d7a059",
"db_language_id": "279a5c86-676b-40e3-98d1-50342423ba79",
"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": "2024-11-21T08:52:28.6169965+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e9cc79a1-343a-47a2-9852-9a7b90e3a92d",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5c48ab49-558c-4b41-894d-c600ae0ff08a",
"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": "aba08744-1485-4425-9389-111cf7116483",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8a491270-e4aa-4b5b-9070-c449eae1e20b"
},
"suggested_date_start": "2024-11-21T08:52:28.6169965+00:00",
"skill_id": "a207df86-f8a7-4ec9-906c-4555a2c9eea9",
"skill_code": "sample string 32",
"skill": {
"id": "2466d3fe-8d91-46ee-8347-b30aca88c324",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "44c661ba-6641-4aff-bcfb-392a63f92711",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "081563da-b164-4b21-a7b0-dfb647e4f628",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40716185-1c49-485f-9df5-bc85ec9e4f22",
"db_currency_id": "d1302f97-1fb1-47d2-b963-389e25c27096",
"db_language_id": "ae2b9065-536b-4cbd-b910-ec7393baa2a5",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a3a022b9-a487-4df3-b77e-054638ad33f0",
"date_reported_by_company": "2024-11-21T08:52:28.6169965+00:00",
"id2": 36,
"company_id": "c759d935-d867-4708-9fab-136a7e5e07da",
"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": "31f27921-f3dc-4c60-a65f-2817d96e7a28",
"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": "2024-11-21T08:52:28.6169965+00:00"
},
"work_instruction_details_id": "6bfeb2e5-d772-4ce5-af32-a74c12d2afc6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b2e2624c-31d4-4f95-93aa-5a7a848c9cea",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b61147fa-7fc1-4e36-9cd2-760a7f3a73fd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-21T08:52:28.6169965+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": "ec575cb8-ea84-48bb-abed-bdcc029ab641",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-21T08:52:28.6169965+00:00"
}