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": "d206e35e-eafd-4552-88fd-59c7fad91eeb", "_parent_id": "692ea6c5-85e5-46df-ad10-8fed5077ce06", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "77be293a-679b-4c03-9c8f-cb4e6806a333", "project_reference_back_office": "sample string 5", "project": { "id": "35bd8b58-6e40-40f5-b342-010fed46a7de", "_parent_id": "e3d4025f-feef-4d5a-b576-473a00dc5a27", "root_parent_id": "11f22e4a-1870-415b-8d85-8bc4c1430a7f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5497f87e-74a9-469e-b1d0-9b4aed8b4dd7", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f4b8a979-975d-42a5-a41d-d26f665c7301", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e189ef8b-3f6e-4d8c-88ba-774c9cf0ef0a", "_parent_code": "sample string 6", "sales_organization_id": "097b3d79-c29c-4ead-8474-4ceeadd01566", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "equipment_model_id": "fe121c03-b571-46ce-8063-a2e643341a8f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "7af9ae99-cdd3-4deb-b1a0-58b5f4557438", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "07d2b33f-9838-4c5c-a659-5cdc53f9bb96", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "de445ab2-6047-43de-95b8-3dc0a43a6b44", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "cf42dff3-d8cb-453d-8bb3-c1098b9a1402", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "equipment_family_id": "2257ec3c-a5cf-43f5-ab7e-930e573e04b5", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f4b8a979-975d-42a5-a41d-d26f665c7301", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e189ef8b-3f6e-4d8c-88ba-774c9cf0ef0a", "_parent_code": "sample string 6", "sales_organization_id": "097b3d79-c29c-4ead-8474-4ceeadd01566", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "date_in_production_since": "2024-12-01T09:48:48.1988231+00:00", "date_out_of_production_since": "2024-12-01T09:48:48.1988231+00:00", "date_end_support": "2024-12-01T09:48:48.1988231+00:00", "sales_organization_id": "801fb03e-7f8e-4fae-939b-b3dd08ae4eb9", "sales_organization_code": "sample string 13", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+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-12-01T09:48:48.1988231+00:00" }, "project_status_id": "7c43ed86-4aa5-4298-8e06-44b79d577e80", "project_status_code": "sample string 10", "project_status": { "id": "0e22627a-cd3c-4a96-9e90-4b9e26c8b508", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f5e0bc49-f00e-4127-a232-a12a03ea8f6a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "company_id": "23ccd28e-2607-492b-aade-0d73f2b4b539", "company_code": "sample string 12", "db_address_id": "57ab917a-755a-4cb8-9066-8be7be5c8e69", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "a391d686-8548-43fb-9362-ae74d2df7aff", "contact_reference_back_office": "sample string 17", "owner_user_id": "18b3cf3c-1a4c-4605-a134-2cd28dfd053e", "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-12-01T09:48:48.1988231+00:00", "date_create": "2024-12-01T09:48:48.1988231+00:00", "date_update": "2024-12-01T09:48:48.1988231+00:00", "updated_by_user_id": "535886ca-987c-4cab-8b62-210647e90191", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-01T09:48:48.1988231+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-12-01T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-01T09:48:48.1988231+00:00", "date_last_job": "2024-12-01T09:48:48.1988231+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-01T09:48:48.1988231+00:00", "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00", "is_mobile_installation": true }, "job_type_id": "e44f4657-92f0-4940-a683-8fefbb09b7a6", "job_type_code": "sample string 7", "job_type": { "id": "ed77bd82-a96e-4bcf-84ad-8576b76fe023", "name": "sample string 2", "sales_organization_id": "8061d36f-e3ab-42c8-8878-7e4b1770be20", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00", "code": "sample string 7" }, "job_priority_id": "1108a8ee-5121-4e58-9e17-7a9a7238f3ab", "job_priority_code": "sample string 9", "job_priority": { "id": "c419d98b-d359-45d6-b5b0-8ac03868f38a", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "ddb05738-dc1f-494c-8667-a45e5b9b545a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "job_status_id": "a5f7806c-87f0-49e7-b33b-159f2dd25e10", "job_status_code": "sample string 11", "db_address_id": "7524ce55-a77f-4a88-9574-46c07eb9be95", "contact_id": "a1220717-cc4d-47f3-8296-fa5599c05161", "requested_by_company_id": "3054ed00-1f7c-412e-bcc8-a6b41ce192e3", "requested_by_contact_id": "8c674027-517e-4b3f-8517-9799bf8e7abb", "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-12-01T09:48:48.1988231+00:00", "due_date": "2024-12-01T09:48:48.1988231+00:00", "date_create": "2024-12-01T09:48:48.1988231+00:00", "date_update": "2024-12-01T09:48:48.1988231+00:00", "date_closed": "2024-12-01T09:48:48.1988231+00:00", "suggested_user_id": "c3d8e767-2ab9-4b8b-9272-0b99432bece2", "suggested_user_code": "sample string 29", "suggested_user": { "id": "165aa9cd-9b97-41b3-8af9-2fff3e403ee7", "db_language_id": "5ecf6974-4fbf-4d97-b8db-320ccb77bf41", "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-12-01T09:48:48.1988231+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "11d3ea90-ff41-4e28-a232-62573659faba", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ecf72c15-5462-4629-812c-8d366ed4df6c", "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": "811e0e5a-ec1f-4dec-89c1-48977516de7d", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "2c01062f-51cc-40a8-a95a-860a6b0e54d0" }, "suggested_date_start": "2024-12-01T09:48:48.1988231+00:00", "skill_id": "af36e7c6-b407-4ebc-b9dd-611d2100e189", "skill_code": "sample string 32", "skill": { "id": "679af4c0-877a-4c92-92bb-7b7c2ddd06eb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "1f8e5013-1f5a-4843-9896-68f8eb93e3a2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8bda348-c51c-45cc-9583-da7a21ce2668", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "31af7f86-332c-42df-a5ac-50e023d1ff93", "db_currency_id": "71d525e1-05be-433e-867b-201b7b0d6f43", "db_language_id": "22f2fd89-748a-4711-afea-3b9332161aab", "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-12-01T09:48:48.1988231+00:00" }, "modified_dateutc": "2024-12-01T09:48:48.1988231+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "9fb9924e-3b7a-42c0-bf12-8930cbc25ab4", "date_reported_by_company": "2024-12-01T09:48:48.1988231+00:00", "id2": 36, "company_id": "d696af3a-c980-468c-a329-e7b8226babd6", "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": "c38d938f-a3ec-4a48-b98d-e9b11f0226a7", "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-12-01T09:48:48.1988231+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.