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": "99e64029-2d78-48e6-af9f-5e277c8ffaf6",
"jobs_id": "c93ba186-984e-4889-847d-286e5054a919",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9edb2c4e-0c93-4f38-b8c0-fa91e64a9c80",
"_parent_id": "54f70245-19cf-4bb6-b2b7-1728810565ff",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2fb87e22-5947-4e5d-8bda-f5f3ddf8f58c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "eb4feb36-893e-417e-89ef-a62afe17d26d",
"_parent_id": "11f614e3-9aa0-4bff-8024-7a72204e10fc",
"root_parent_id": "f8b3e356-8c09-4d87-b9e0-5c8feef0202a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "012f8672-b53d-406c-a1a8-1b22f4b39da5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6e2a6b59-e843-40f7-b7a4-49590a09b2ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13931772-c39e-40e3-87b3-d0459b7307f6",
"_parent_code": "sample string 6",
"sales_organization_id": "8867b37a-abc8-486f-9f32-3e3541d8a07a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"equipment_model_id": "301d8f1a-b89a-4885-8d46-5274a246fda6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97699d2c-bf18-4c4a-b2e5-12a22097b5a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9111e110-e562-488d-b20b-3440abcea949",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "03764bb6-e757-4ca2-9bae-f6419e2efddb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "15a7af07-9189-4e7e-b126-8fc104b7c26f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"equipment_family_id": "5c41021b-6cbe-467a-8b54-962f7cf492a6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6e2a6b59-e843-40f7-b7a4-49590a09b2ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13931772-c39e-40e3-87b3-d0459b7307f6",
"_parent_code": "sample string 6",
"sales_organization_id": "8867b37a-abc8-486f-9f32-3e3541d8a07a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"date_in_production_since": "2024-04-22T05:41:57.4115492+00:00",
"date_out_of_production_since": "2024-04-22T05:41:57.4115492+00:00",
"date_end_support": "2024-04-22T05:41:57.4115492+00:00",
"sales_organization_id": "a4747c98-d13a-4722-a9f0-d0aaebb9f7f1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+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-04-22T05:41:57.4115492+00:00"
},
"project_status_id": "2dfde57f-e4e2-4d5f-8ab2-9d860c8d6650",
"project_status_code": "sample string 10",
"project_status": {
"id": "8c13e3e2-9128-421c-a7a2-5320642695e5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "99ceb374-2b3a-4318-a13e-76a68463bad1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"company_id": "d7254145-0ed2-417a-bdb9-b22d67797103",
"company_code": "sample string 12",
"db_address_id": "2a0970e5-bb56-4c65-a82c-a32b4e0f648e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ae547ede-7159-4675-90e0-e2951d6c7a0e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "20d1676d-4277-40b7-8789-4eb44a39d667",
"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-04-22T05:41:57.4115492+00:00",
"date_create": "2024-04-22T05:41:57.4115492+00:00",
"date_update": "2024-04-22T05:41:57.4115492+00:00",
"updated_by_user_id": "98416d16-0146-4d95-b8b3-904d70a48d60",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-22T05:41:57.4115492+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-04-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-22T05:41:57.4115492+00:00",
"date_last_job": "2024-04-22T05:41:57.4115492+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-22T05:41:57.4115492+00:00",
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00",
"is_mobile_installation": true
},
"job_type_id": "7dc2d470-8979-42c6-b412-ef5e0af24ed7",
"job_type_code": "sample string 7",
"job_type": {
"id": "4b72a573-d895-4951-93a0-f23c09b40e58",
"name": "sample string 2",
"sales_organization_id": "af00748c-24d6-431f-b59d-c9324e00815b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00",
"code": "sample string 7"
},
"job_priority_id": "5aee778e-53a2-468e-9c1f-3005817678b5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e5a5fc2-4093-4d41-8bf1-8ee07ae464d9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a9891c26-b4d2-440a-b0f2-533ed5b0b583",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"job_status_id": "c1dfc3d8-4215-4e5a-9985-65cdf22fca41",
"job_status_code": "sample string 11",
"db_address_id": "6018ea8f-90c5-4544-aef7-70d5e2be70b4",
"contact_id": "ab9000ca-e787-4fee-89e3-b5b329270849",
"requested_by_company_id": "0c966777-c7be-401f-9394-1153abf30e4a",
"requested_by_contact_id": "d9199af0-a7a0-4730-8902-15e5b2b13ee3",
"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-04-22T05:41:57.4115492+00:00",
"due_date": "2024-04-22T05:41:57.4115492+00:00",
"date_create": "2024-04-22T05:41:57.4115492+00:00",
"date_update": "2024-04-22T05:41:57.4115492+00:00",
"date_closed": "2024-04-22T05:41:57.4115492+00:00",
"suggested_user_id": "6190a55d-d05d-4c78-92be-7f3e6c39ece4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6c964087-4ba4-47fe-bfce-d813295bc3c1",
"db_language_id": "9a3f231b-f467-45d4-874b-f414f22cd95d",
"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-04-22T05:41:57.4115492+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3caa5fa1-b02a-45c3-a344-c9a5619b78d8",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "850f4dfa-216b-4adb-83ba-e4c5abd5ebc5",
"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": "ab3bd03e-429e-4c7a-92a5-6f6faa5791fb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7d4a408d-99b6-4518-8d3d-e81506fec17c"
},
"suggested_date_start": "2024-04-22T05:41:57.4115492+00:00",
"skill_id": "031fabf8-08b2-410f-8a05-83d016b467f4",
"skill_code": "sample string 32",
"skill": {
"id": "c03e61a0-5ebb-4dd8-882c-521de9466b84",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "213a970c-b534-4009-84a3-2673b640c447",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c61e7fb-c18f-4044-9698-60be03e6a4bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34daf115-bde3-4018-b97b-9c8d0e0b6003",
"db_currency_id": "f44d9890-b6c0-4c11-a8bb-3967fa8a2116",
"db_language_id": "fc52ff4e-7c00-496f-9595-a3779a4ab81d",
"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-04-22T05:41:57.4115492+00:00"
},
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "908b545c-8be6-4fa1-a6f7-41e385f1ca6a",
"date_reported_by_company": "2024-04-22T05:41:57.4115492+00:00",
"id2": 36,
"company_id": "7a7ddf70-eaa7-41ab-a707-7bd1958774e4",
"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": "81301cf9-f5a3-43e2-9699-9d1de7afa53e",
"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-04-22T05:41:57.4115492+00:00"
},
"work_instruction_details_id": "3bcbd002-0d2f-4aeb-9ad5-f4a112206aaf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "74e90346-3dec-4b0e-bdd5-839ec340eea5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ee3c0ab-704c-483a-a2ec-b8cdd117b632",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-22T05:41:57.4115492+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": "66209c9e-f485-445e-a26c-34da155ce183",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-22T05:41:57.4115492+00:00"
}