Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
{ "id": "3e33b602-213e-45e9-a319-8c640456d33a", "_parent_id": "7bb50b75-056a-4f8d-95a7-1bc068542af6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c31b0d59-3b4c-48c1-af03-bfba429d66ae", "project_reference_back_office": "sample string 5", "project": { "id": "e6ecc61e-dbec-4536-a85c-c2e3619fe268", "_parent_id": "876ff1c0-516a-4390-aa34-eeef9e57546a", "root_parent_id": "ccedcb8a-1f7c-41c9-b1c2-414f3e22cb20", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "8c43b7ae-af13-4e9c-a8dd-fca47697f925", "equipment_family_code": "sample string 6", "equipment_family": { "id": "522bf8d2-714a-46d9-b0af-b639271ce49c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b1a40aad-3c60-4f1d-9bac-551aa673cd18", "_parent_code": "sample string 6", "sales_organization_id": "4ca3147c-0a1c-4061-852a-053122217b09", "sales_organization_code": "sample string 8", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "equipment_model_id": "7a8c87d6-665c-42ea-bcd5-8ed2b95991f0", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b75cb693-b5c8-40f7-af15-29b7be230ccc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "51331b4e-dafb-47d2-af97-2f091f57aa8c", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "249f4700-39c9-4542-b4a2-bc54d1373b5e", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7a107cfd-9963-4cc6-8b8a-a9bb4d782561", "sales_organization_code": "sample string 5", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "equipment_family_id": "1f0db0c9-a4ef-4347-baab-99e59e9ca679", "equipment_family_code": "sample string 8", "equipment_family": { "id": "522bf8d2-714a-46d9-b0af-b639271ce49c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b1a40aad-3c60-4f1d-9bac-551aa673cd18", "_parent_code": "sample string 6", "sales_organization_id": "4ca3147c-0a1c-4061-852a-053122217b09", "sales_organization_code": "sample string 8", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "date_in_production_since": "2024-11-21T08:47:52.8132121+00:00", "date_out_of_production_since": "2024-11-21T08:47:52.8132121+00:00", "date_end_support": "2024-11-21T08:47:52.8132121+00:00", "sales_organization_id": "83c0cb83-ca5d-4a4b-aab9-384174f63d42", "sales_organization_code": "sample string 13", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+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:47:52.8132121+00:00" }, "project_status_id": "123fb9df-6bb3-4133-a670-a74b7b25a714", "project_status_code": "sample string 10", "project_status": { "id": "571aea9f-3c2a-463d-a7b8-9afb1b077c5e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "fd41e13e-506d-4af2-9d4a-2200a0fac126", "sales_organization_code": "sample string 6", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "company_id": "55218cf7-aba6-4187-ab5b-d1263bb55246", "company_code": "sample string 12", "db_address_id": "738d0098-2e0e-43f9-9f6b-f17afbb8e34b", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "cc493b3a-c0d9-45c6-bd88-081afb1509a1", "contact_reference_back_office": "sample string 17", "owner_user_id": "c4676c41-3d55-4fe5-ac95-faa8d2a19d39", "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:47:52.8132121+00:00", "date_create": "2024-11-21T08:47:52.8132121+00:00", "date_update": "2024-11-21T08:47:52.8132121+00:00", "updated_by_user_id": "0b0a872d-3ba9-4ddc-bc9c-c7f45f016602", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-21T08:47:52.8132121+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:47:52.8132121+00:00", "date_last_job": "2024-11-21T08:47:52.8132121+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-21T08:47:52.8132121+00:00", "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00", "is_mobile_installation": true }, "job_type_id": "561c5cba-a1d7-46bc-ac34-d51e09eb2862", "job_type_code": "sample string 7", "job_type": { "id": "772f4fdf-08d5-4eb9-b2a7-2eedcbb063d2", "name": "sample string 2", "sales_organization_id": "82696e41-e946-4745-92de-85f48d3a592d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00", "code": "sample string 7" }, "job_priority_id": "510022c9-d52f-4abb-92aa-9fa159a732a0", "job_priority_code": "sample string 9", "job_priority": { "id": "7d816051-37f4-44cf-96cd-2e816c495d83", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "91feeea1-2dd8-4004-bdd4-7f9f045f0f69", "sales_organization_code": "sample string 6", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "job_status_id": "4e0a23f5-4f0b-4a03-acc9-3401ea41192c", "job_status_code": "sample string 11", "db_address_id": "e0962e0b-a9ce-4c01-b39d-7dca2112f9b0", "contact_id": "5ab0e958-2131-49ec-8586-f684785ca7db", "requested_by_company_id": "fa0130f2-ad94-4d42-b489-2c1f5f3d9b63", "requested_by_contact_id": "035b0f28-1365-4842-a679-20df7630ca1b", "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:47:52.8132121+00:00", "due_date": "2024-11-21T08:47:52.8132121+00:00", "date_create": "2024-11-21T08:47:52.8132121+00:00", "date_update": "2024-11-21T08:47:52.8132121+00:00", "date_closed": "2024-11-21T08:47:52.8132121+00:00", "suggested_user_id": "b4c36924-6655-4d95-8fe2-adc298b05f30", "suggested_user_code": "sample string 29", "suggested_user": { "id": "f48b89ae-2ee1-41a3-9469-c83adedc83af", "db_language_id": "5f172723-f2e3-4760-aa23-b9fc9b1057e4", "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:47:52.8132121+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "025c0f9b-77f8-432b-899f-ed05855e1533", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e687f4f9-93cf-4cfa-8903-05e76ed23d32", "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": "e48ab186-054f-417e-ac09-f15ae5c41443", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c2ea0308-0abe-46fb-9843-ec3f08740d65" }, "suggested_date_start": "2024-11-21T08:47:52.8132121+00:00", "skill_id": "4345ca0d-dea9-4855-9f82-733b14b9b2a4", "skill_code": "sample string 32", "skill": { "id": "d82e231a-4bc3-4b88-8d6b-91c63fad5717", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "337edd96-8227-4f59-a741-91098e54113f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "013cff15-a9fa-4282-8df3-faa62afeee73", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a086f021-3c5c-4c0b-8366-a5b3df5fb08c", "db_currency_id": "2a51e99b-ec09-4bea-9404-bfebd8b8a882", "db_language_id": "715b3cae-b5aa-4321-8611-9a45810ba9d5", "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:47:52.8132121+00:00" }, "modified_dateutc": "2024-11-21T08:47:52.8132121+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "307ef142-9083-4b47-91aa-50929ccf9ac6", "date_reported_by_company": "2024-11-21T08:47:52.8132121+00:00", "id2": 36, "company_id": "ebd9b2c8-d9a7-4327-b948-7f9926803e2e", "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": "036753fe-f051-4a84-a5de-36e914f0d4a0", "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:47:52.8132121+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.