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": "cb22f5a2-9c0d-444e-8362-f93838e4b6f3", "_parent_id": "5f140c13-2261-4603-9540-53545e435a87", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "6dac1459-f279-405f-a045-0892054f92ad", "project_reference_back_office": "sample string 5", "project": { "id": "600c1af8-9f04-4b45-851e-3832742d1fe8", "_parent_id": "c7483a47-09c3-42fd-b904-90f188d803cf", "root_parent_id": "439a6d4a-3602-418a-990f-fcd016e1d258", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b2249b42-3fd7-4c0d-a4f9-b62783c8f0ab", "equipment_family_code": "sample string 6", "equipment_family": { "id": "416916a4-2bc2-4580-a021-9910159de917", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "423c6149-1ca6-403d-94c3-7b9e7ed74c63", "_parent_code": "sample string 6", "sales_organization_id": "c45c0985-842d-43ec-afc7-b43f6749a4bc", "sales_organization_code": "sample string 8", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "equipment_model_id": "cd949ff4-90c4-46e1-b842-011027f07882", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b31af434-26c0-426c-99d6-df9871508ae4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "89abd525-36a6-4289-9e31-4dc6d5d11a89", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "0302b41b-4cb8-436c-b061-3e04ae937573", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "552c35e2-049b-44e5-9a19-59664abdc4e5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "equipment_family_id": "c10a5d3a-8140-4f4b-ab00-86f2c8b91001", "equipment_family_code": "sample string 8", "equipment_family": { "id": "416916a4-2bc2-4580-a021-9910159de917", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "423c6149-1ca6-403d-94c3-7b9e7ed74c63", "_parent_code": "sample string 6", "sales_organization_id": "c45c0985-842d-43ec-afc7-b43f6749a4bc", "sales_organization_code": "sample string 8", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "date_in_production_since": "2024-07-20T13:21:09.8728977+00:00", "date_out_of_production_since": "2024-07-20T13:21:09.8728977+00:00", "date_end_support": "2024-07-20T13:21:09.8728977+00:00", "sales_organization_id": "0c771279-6f96-4a3c-abbc-a97af45260bb", "sales_organization_code": "sample string 13", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+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-07-20T13:21:09.8728977+00:00" }, "project_status_id": "640bb64c-5435-4057-b8a2-8ae220eeb59f", "project_status_code": "sample string 10", "project_status": { "id": "634f1e5b-25ec-4702-84ef-cd1653c3dae9", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "acaafb84-cb1c-48e8-a112-75a1eefba357", "sales_organization_code": "sample string 6", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "company_id": "7f742261-4cb0-4ad6-95ec-6f9b10f4a13f", "company_code": "sample string 12", "db_address_id": "ca3e9f4a-63e0-49dc-a675-2e0d804a569c", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b7d8f794-7d5c-4db8-ad30-b79c8304d2ac", "contact_reference_back_office": "sample string 17", "owner_user_id": "ce5a2a30-dd90-47da-928f-1c1d1e4a71da", "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-07-20T13:21:09.8728977+00:00", "date_create": "2024-07-20T13:21:09.8728977+00:00", "date_update": "2024-07-20T13:21:09.8728977+00:00", "updated_by_user_id": "6649bb43-3547-4aa5-98ea-79603345fe98", "customer_reference": "sample string 28", "warranty_date_until": "2024-07-20T13:21:09.8728977+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-07-20T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-07-20T13:21:09.8728977+00:00", "date_last_job": "2024-07-20T13:21:09.8728977+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-07-20T13:21:09.8728977+00:00", "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00", "is_mobile_installation": true }, "job_type_id": "23265dc1-df40-45cd-b90d-cf8d92276d6a", "job_type_code": "sample string 7", "job_type": { "id": "ad70fefc-48bb-4c76-bbce-537758e202e2", "name": "sample string 2", "sales_organization_id": "a0d97c72-c494-4ab3-9448-7a04c5cef723", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00", "code": "sample string 7" }, "job_priority_id": "379a4212-a0df-42e2-8ce3-647566c01b26", "job_priority_code": "sample string 9", "job_priority": { "id": "fab0c24c-93c3-41f2-94a2-d5e248fee38b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "5f6b5787-9370-4c14-91a2-7195d6c7ee85", "sales_organization_code": "sample string 6", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "job_status_id": "a786e8fe-7d9d-48bc-a2ba-9a5c0711db06", "job_status_code": "sample string 11", "db_address_id": "4c306b99-877b-4ec2-847a-691d4fa15620", "contact_id": "bb74fda2-78c8-459e-9628-bce22cca9877", "requested_by_company_id": "adc476fa-6f0c-41ed-b95d-5afdeaa459e9", "requested_by_contact_id": "2f19384e-9426-45e1-a47c-8ba80cb74477", "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-07-20T13:21:09.8728977+00:00", "due_date": "2024-07-20T13:21:09.8728977+00:00", "date_create": "2024-07-20T13:21:09.8728977+00:00", "date_update": "2024-07-20T13:21:09.8728977+00:00", "date_closed": "2024-07-20T13:21:09.8728977+00:00", "suggested_user_id": "c3421e4d-4c0a-4c44-8d40-f6f0969e2ef3", "suggested_user_code": "sample string 29", "suggested_user": { "id": "713a3b71-f1b0-4cd9-ada7-d10dd4878dea", "db_language_id": "3449cc42-2dfc-4e54-b08e-64fd2cb8bdc7", "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-07-20T13:21:09.8728977+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "59196b78-01ea-4c2f-80a9-f27186a9462f", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "7a8205b8-8a63-4849-8d1e-b6aec7ff8f1c", "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": "94cf1640-a1c1-413c-89f5-8ba88980c2a0", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "b56c288a-dc1d-4b42-8b35-194472010dec" }, "suggested_date_start": "2024-07-20T13:21:09.8728977+00:00", "skill_id": "62a60e05-49c2-4b0e-be8c-e02545112627", "skill_code": "sample string 32", "skill": { "id": "c9be9015-d8f3-495e-b9a0-f3ed7bcd03fb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2ba37d0c-8609-4f0b-b6bf-ac4a252c73b7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "caed4e95-9c3f-4212-bee4-c3a0a153fc25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d8e9e2dd-1d06-42b4-a893-61b03219c5ed", "db_currency_id": "74e2e253-cf72-42ee-8f6a-94669ed88e2d", "db_language_id": "a4f7ea72-b9ce-4121-a523-92811c2603b3", "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-07-20T13:21:09.8728977+00:00" }, "modified_dateutc": "2024-07-20T13:21:09.8728977+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "658bf505-35f9-412b-8843-a98062386559", "date_reported_by_company": "2024-07-20T13:21:09.8728977+00:00", "id2": 36, "company_id": "504971c7-6a9c-4144-9b3b-708cdc1e6c36", "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": "cb27ccf6-a04e-4323-b261-5ed0757703d8", "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-07-20T13:21:09.8728977+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.