Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
jobsName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
_parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
_parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
_parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
name |
Name of the Job |
string |
Required Max length: 255 |
description |
Description of the job |
string |
Max length: 4000 |
working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
due_date |
Deadline of Max date for the planning (Not After) |
date | |
date_create |
Creation date+time |
date | |
date_update |
Update date+time |
date | |
date_closed |
Date+time job goes to completed |
date | |
suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
skill |
Embedded entity "skill" when adding/updating job |
skill | |
customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
date_reported_by_company |
Date+time when company reported the problem |
date | |
id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
company_code |
This field will be filled automatically based on the project_id |
string | |
db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_street2 |
It is sub street |
string |
Max length: 50 |
db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
db_address_db_country_code |
When mobile equipment, the address to use |
string | |
db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
db_address_latitude_decimal |
Latitude |
decimal number | |
db_address_longitude_decimal |
Latitude |
decimal number | |
estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{ "id": "5d1fd1d5-212f-4010-842a-57c91d7b29f5", "_parent_id": "991dcbfa-ce95-48f7-8d4a-8e7fca7f8802", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "06c40872-9e2f-41ae-9ca1-5a3d0a4ee297", "project_reference_back_office": "sample string 5", "project": { "id": "de592d4b-2649-458b-a4be-aca166c10fdb", "_parent_id": "a0d00e8d-2ad4-4ae9-8ed9-68485ca1aef3", "root_parent_id": "f11e2dc6-c33d-457b-a23b-b1c3bfe552a4", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7b94310d-ec42-4686-b9ad-cd6cd264046c", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4eef59fc-c834-45d9-90c4-7056271d9ff7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "877f275b-4567-4f11-b06f-b818201cb8ce", "_parent_code": "sample string 6", "sales_organization_id": "e7717dec-f677-4b9a-a687-c3f5dbf58719", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "equipment_model_id": "4f47140f-5e30-40c5-aa44-620db1052ae8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "21edb3ab-ca3f-4773-a36f-098a4db59581", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "21802b92-1b53-4503-beb3-d1e3209f916f", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "38da02bb-c163-46e7-b818-f7e4926e3e20", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "65cdc2d4-7373-4f66-9f9d-afa22db5c9b2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "equipment_family_id": "6eead332-ec47-4f94-ade6-8fb4f56e7f2a", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4eef59fc-c834-45d9-90c4-7056271d9ff7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "877f275b-4567-4f11-b06f-b818201cb8ce", "_parent_code": "sample string 6", "sales_organization_id": "e7717dec-f677-4b9a-a687-c3f5dbf58719", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "date_in_production_since": "2023-03-29T03:44:04.2210023+00:00", "date_out_of_production_since": "2023-03-29T03:44:04.2210023+00:00", "date_end_support": "2023-03-29T03:44:04.2210023+00:00", "sales_organization_id": "1bba8474-514c-42c6-9d73-4337a4b8f3a9", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+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": "2023-03-29T03:44:04.2210023+00:00" }, "project_status_id": "7500fe72-daf7-4dad-ab6a-bce87e9f9e46", "project_status_code": "sample string 10", "project_status": { "id": "43698ebe-b8b6-4e26-bb65-728056a848c3", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "08235667-db66-4b1a-ae21-d41934860c63", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "company_id": "d3290653-a732-484f-a89e-dd6901106b61", "company_code": "sample string 12", "db_address_id": "3e99c5e7-e516-4d50-a699-ba9590d10ce2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "da9dabbc-ba6c-41cf-82b7-aca42e3a4181", "contact_reference_back_office": "sample string 17", "owner_user_id": "0371cb22-c128-44a1-ab26-d838098fc692", "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": "2023-03-29T03:44:04.2210023+00:00", "date_create": "2023-03-29T03:44:04.2210023+00:00", "date_update": "2023-03-29T03:44:04.2210023+00:00", "updated_by_user_id": "8a934903-8bc6-4e1b-92d5-349addc51ad9", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-29T03:44:04.2210023+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": "2023-03-29T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-29T03:44:04.2210023+00:00", "date_last_job": "2023-03-29T03:44:04.2210023+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-29T03:44:04.2210023+00:00", "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00", "is_mobile_installation": true }, "job_type_id": "82c0c1b1-481c-4f1c-a799-a5a520bfd5cf", "job_type_code": "sample string 7", "job_type": { "id": "61e42639-fd64-4813-a93b-d56b5112197f", "name": "sample string 2", "sales_organization_id": "94f5930e-4568-4b5e-ab4f-e3d7396a790a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00", "code": "sample string 7" }, "job_priority_id": "4648ad84-2534-491a-a02c-f58d423e6f4d", "job_priority_code": "sample string 9", "job_priority": { "id": "4dbc5752-421b-4b0a-befb-c2e239cbfa69", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "33c99e99-cd75-4882-888f-d548cccfe5db", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "job_status_id": "b5f08b42-9819-4d73-9259-1fffd054edbd", "job_status_code": "sample string 11", "db_address_id": "a8a0f124-4e35-4b72-bd8d-cccbf0256201", "contact_id": "156d22af-eed3-4587-9a6e-2dbbe3e2b2f4", "requested_by_company_id": "f57b96fd-950d-4067-bbb5-feca1c52eafc", "requested_by_contact_id": "f62ee1ea-6968-4f13-8329-f26e79741b48", "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": "2023-03-29T03:44:04.2210023+00:00", "due_date": "2023-03-29T03:44:04.2210023+00:00", "date_create": "2023-03-29T03:44:04.2210023+00:00", "date_update": "2023-03-29T03:44:04.2210023+00:00", "date_closed": "2023-03-29T03:44:04.2210023+00:00", "suggested_user_id": "95d2578a-e9dd-4712-925b-8d6a9a1f3668", "suggested_user_code": "sample string 29", "suggested_user": { "id": "518eef78-7d22-455b-a343-b09e7d08aa8d", "db_language_id": "f7eeb1d8-5430-49b8-ac21-4453fab4ca94", "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": "2023-03-29T03:44:04.2210023+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "ef54a236-3cea-4086-a58b-696ba5f1855a", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "168ca5dc-43e3-453b-85c5-e0dfad6ecb87", "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": "a0865aea-a4b2-40b7-aa66-0819667246cb", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "90c33105-faa3-4d58-b47b-181da5b82a83" }, "suggested_date_start": "2023-03-29T03:44:04.2210023+00:00", "skill_id": "910e1b8b-5383-4bff-841b-5c30fd932e4a", "skill_code": "sample string 32", "skill": { "id": "7de278d6-c3a4-42c8-95d8-3ca8c2738499", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a01179dd-a18e-4b8f-a65a-55e4e0a470e8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8619b480-95ef-4bbb-9423-d5b1739b4bde", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "57bac083-e2ac-4dd4-b7cf-ae3e87545cbc", "db_currency_id": "55b0a155-7a6c-4a36-ae7e-9e8390216ed4", "db_language_id": "4d635644-d2c3-492e-b5fc-32ac3c461dcb", "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": "2023-03-29T03:44:04.2210023+00:00" }, "modified_dateutc": "2023-03-29T03:44:04.2210023+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e78a3245-a055-4dae-884b-368011f56440", "date_reported_by_company": "2023-03-29T03:44:04.2210023+00:00", "id2": 36, "company_id": "0ef62fec-2d61-4d1b-9313-566cda54d71a", "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": "111836f4-299d-47b2-b17f-ca4833caf83b", "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": "2023-03-29T03:44:04.2210023+00:00" }