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": "81a6ca48-d312-40c1-aea4-edf4dddcac0a", "_parent_id": "58212847-d925-4135-9806-14256cfbba4e", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "8e937a96-d640-48c5-a49e-0735e637ed7c", "project_reference_back_office": "sample string 5", "project": { "id": "84bb1a6f-3f5c-4593-9424-ce550c485ef4", "_parent_id": "5d758b3a-835b-48d7-8f85-4d50f258e81f", "root_parent_id": "4560d618-e6da-4388-a427-ae44dcc4afc2", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "74f93052-191e-4d60-9b5d-dcf326900b94", "equipment_family_code": "sample string 6", "equipment_family": { "id": "07155a96-8ca3-402d-9a42-008c0d53168b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "2879f330-eb82-4050-b648-ed639cff0a25", "_parent_code": "sample string 6", "sales_organization_id": "af63d583-11f4-4eb8-9d16-1e2b87df734e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "equipment_model_id": "99881914-bdcd-494a-85e8-d5d5fbb8e43f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f26c7255-5764-4c18-8798-ca738d701eb7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "93c5628b-d3f3-49a4-b258-6542a14e5a06", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "1a213cb5-be19-4b5b-bb04-f9b469e8c013", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3cdef09f-646c-41eb-9a6c-aa82f01052f0", "sales_organization_code": "sample string 5", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "equipment_family_id": "08a2a00a-8380-4b6c-8fab-a1750a3e0c23", "equipment_family_code": "sample string 8", "equipment_family": { "id": "07155a96-8ca3-402d-9a42-008c0d53168b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "2879f330-eb82-4050-b648-ed639cff0a25", "_parent_code": "sample string 6", "sales_organization_id": "af63d583-11f4-4eb8-9d16-1e2b87df734e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "date_in_production_since": "2023-03-31T21:39:55.9212925+00:00", "date_out_of_production_since": "2023-03-31T21:39:55.9212925+00:00", "date_end_support": "2023-03-31T21:39:55.9212925+00:00", "sales_organization_id": "f47c7526-b6b5-4d41-b2a1-54a5c96715f9", "sales_organization_code": "sample string 13", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+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-31T21:39:55.9212925+00:00" }, "project_status_id": "e36619a6-4515-4583-b9ef-1ba07d95b5d2", "project_status_code": "sample string 10", "project_status": { "id": "11805879-8516-4620-8c43-d653c6a1df4c", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "5898b74a-7a19-4ec2-a275-5ab1f184ec50", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "company_id": "f68f2bfe-5a36-44db-b4c8-36eeba9d6609", "company_code": "sample string 12", "db_address_id": "e994f555-100d-456b-a25d-1ceb4ea7d8c8", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7d41c15a-e941-49a0-8909-f9b526c74d43", "contact_reference_back_office": "sample string 17", "owner_user_id": "3b2572d1-31c1-4362-a8d6-946eb2811a80", "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-31T21:39:55.9212925+00:00", "date_create": "2023-03-31T21:39:55.9212925+00:00", "date_update": "2023-03-31T21:39:55.9212925+00:00", "updated_by_user_id": "8aeb29f4-8ee3-44e8-be8f-6a48af94e8d0", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-31T21:39:55.9212925+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-31T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-31T21:39:55.9212925+00:00", "date_last_job": "2023-03-31T21:39:55.9212925+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-31T21:39:55.9212925+00:00", "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00", "is_mobile_installation": true }, "job_type_id": "3655374d-5357-4e69-976f-8efed3ae6bd9", "job_type_code": "sample string 7", "job_type": { "id": "0ee644aa-5c1f-4b3c-b00c-6cf8bba7485c", "name": "sample string 2", "sales_organization_id": "86ee2a0c-6596-4f8d-9f0a-3e6aeadcaae5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00", "code": "sample string 7" }, "job_priority_id": "4e161ee9-396e-4150-bae8-daac5c6cc99b", "job_priority_code": "sample string 9", "job_priority": { "id": "87331cba-b4ca-4c73-9fb8-d830ab64ffc8", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9e210f92-4195-472b-9e9c-b91e53cfd09f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "job_status_id": "36958dca-61e4-4620-aa07-36737c859e0f", "job_status_code": "sample string 11", "db_address_id": "ae6223a7-0862-4c07-be0b-b810d9e00c32", "contact_id": "e7b5d696-5975-48f5-91fb-012b7a0c295d", "requested_by_company_id": "a54a43f2-f3b1-4583-ad6d-62ffcea3f517", "requested_by_contact_id": "bc1aef09-63ea-40c3-94a8-fd23083aeef5", "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-31T21:39:55.9212925+00:00", "due_date": "2023-03-31T21:39:55.9212925+00:00", "date_create": "2023-03-31T21:39:55.9212925+00:00", "date_update": "2023-03-31T21:39:55.9212925+00:00", "date_closed": "2023-03-31T21:39:55.9212925+00:00", "suggested_user_id": "465fc5c2-7449-4503-9fa0-b59f310877f7", "suggested_user_code": "sample string 29", "suggested_user": { "id": "50d0306a-4ecb-4f46-af02-322b1081e02f", "db_language_id": "17ec3b21-ba9a-4e05-b8d1-7a3f28cb88ce", "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-31T21:39:55.9212925+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e5865902-0eda-4446-9fa1-eb750b896ab7", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "d6f9f537-2fe7-4e48-be40-47ce7f5b380a", "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": "717348d9-ef96-4754-a26c-ed54672f289c", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "57b8b012-460d-4863-878e-32187808eb45" }, "suggested_date_start": "2023-03-31T21:39:55.9212925+00:00", "skill_id": "79cea106-f678-4fc3-9d54-c743e59596c2", "skill_code": "sample string 32", "skill": { "id": "8af132f5-22e0-45ed-94cb-2d8d1f87060d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "194a375c-3f15-4bfe-ac45-256d85775d13", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6ed6cea9-0554-4612-8317-c54230ba7f46", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "23f2c816-60f3-4254-b893-4adfeb165f2e", "db_currency_id": "69666a6f-2641-4d06-86f9-31efd18a8ff8", "db_language_id": "e7ee1788-975b-456d-92f3-f04e1d1aee58", "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-31T21:39:55.9212925+00:00" }, "modified_dateutc": "2023-03-31T21:39:55.9212925+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e5b28b02-1e42-4354-aabc-2559c026b21a", "date_reported_by_company": "2023-03-31T21:39:55.9212925+00:00", "id2": 36, "company_id": "cae3b165-c341-4280-92e3-8981dd1e8735", "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": "964bfa14-eb79-46c4-a4fc-b745d29c699c", "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-31T21:39:55.9212925+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.