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": "0f0dcb7f-dfa1-4cda-ba9b-ff84b97b4537", "_parent_id": "405453d7-2d7c-4132-ac9d-fa9098bae6b5", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3f26478a-1910-4f8b-96b0-e4738c79406e", "project_reference_back_office": "sample string 5", "project": { "id": "575296d0-27d9-4ab1-8278-caaaaafa6810", "_parent_id": "d20d3525-f68d-4d03-bab9-d051125e8744", "root_parent_id": "78e0497e-1f67-4d02-bb89-2ec498b5fa36", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b0c3d544-63e0-4516-8d08-fff8f9cf7767", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d96d09eb-84f1-4c6c-a553-09bce13af03b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "661e4796-759f-44ae-acd8-2e4e9695fcee", "_parent_code": "sample string 6", "sales_organization_id": "c1cb53fe-94f4-4903-adba-c74687c401e3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "equipment_model_id": "a801b65f-2347-4fc1-bf8c-75456b69af3f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d22b3625-5a92-4822-ba5d-a967f7c8c662", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "0adb5414-b3ba-4461-be38-16d743fe16d2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "96b7f3f3-0f6a-400a-9dd7-8c6a065645d3", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "59ed4a43-3980-4bba-bac5-380c7c765094", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "equipment_family_id": "18686f36-a23a-41ba-bee7-af735119befe", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d96d09eb-84f1-4c6c-a553-09bce13af03b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "661e4796-759f-44ae-acd8-2e4e9695fcee", "_parent_code": "sample string 6", "sales_organization_id": "c1cb53fe-94f4-4903-adba-c74687c401e3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "date_in_production_since": "2024-04-16T15:48:40.1892354+00:00", "date_out_of_production_since": "2024-04-16T15:48:40.1892354+00:00", "date_end_support": "2024-04-16T15:48:40.1892354+00:00", "sales_organization_id": "029593a7-852d-4a2b-aabd-7b6950553462", "sales_organization_code": "sample string 13", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+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-04-16T15:48:40.1892354+00:00" }, "project_status_id": "0defde8f-c139-4875-b881-100090a1e3ae", "project_status_code": "sample string 10", "project_status": { "id": "a1801ad3-4632-4211-8ca1-b63821f4f344", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "919dfe4f-c295-4a54-b6ae-f3800a8519e1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "company_id": "dbceb423-2b97-4dc1-833d-84738bd3f2d8", "company_code": "sample string 12", "db_address_id": "2bdfb4fb-5c09-4b28-b0bf-a701e0eea515", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "991ed890-1c4d-4050-8003-eef7ba825cee", "contact_reference_back_office": "sample string 17", "owner_user_id": "1ee35d64-7ec7-4ef8-9c04-171d4f53d7a1", "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-04-16T15:48:40.1892354+00:00", "date_create": "2024-04-16T15:48:40.1892354+00:00", "date_update": "2024-04-16T15:48:40.1892354+00:00", "updated_by_user_id": "a126a77f-7173-47b8-87b8-29d8312e9b37", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-16T15:48:40.1892354+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-04-16T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-16T15:48:40.1892354+00:00", "date_last_job": "2024-04-16T15:48:40.1892354+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-16T15:48:40.1892354+00:00", "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00", "is_mobile_installation": true }, "job_type_id": "ef9d9e15-3c70-42ae-91f6-971d1a5a5100", "job_type_code": "sample string 7", "job_type": { "id": "1b1fd49f-57a4-44fc-a220-4d8712a24b3c", "name": "sample string 2", "sales_organization_id": "8fd115a3-c272-4195-b660-ce31cb00a6ac", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00", "code": "sample string 7" }, "job_priority_id": "7cb61dec-0427-4227-bfe5-972039c6e6b8", "job_priority_code": "sample string 9", "job_priority": { "id": "03e2300a-9379-457c-a18d-fdd6a9c5da40", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9ac2547f-baff-419c-8436-cbeaec96d878", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "job_status_id": "6483f308-1954-44df-b697-23220e07e7f6", "job_status_code": "sample string 11", "db_address_id": "01eb26da-724d-485d-8a6e-45120185d455", "contact_id": "658075a7-9a96-4a6c-aa0f-e7d90404a855", "requested_by_company_id": "d2369b46-20f0-4eca-99e7-021dc88cb607", "requested_by_contact_id": "1219af0b-fc36-4394-8672-ec4b11987293", "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-04-16T15:48:40.1892354+00:00", "due_date": "2024-04-16T15:48:40.1892354+00:00", "date_create": "2024-04-16T15:48:40.1892354+00:00", "date_update": "2024-04-16T15:48:40.1892354+00:00", "date_closed": "2024-04-16T15:48:40.1892354+00:00", "suggested_user_id": "6918d957-cbc5-4762-9293-635211bdb695", "suggested_user_code": "sample string 29", "suggested_user": { "id": "d0bec960-92d0-4cfe-b9d8-b4a60c655fe4", "db_language_id": "e12ab8bf-807b-441d-b194-8e5ac6bbd15b", "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-04-16T15:48:40.1892354+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2bf247c1-8e7c-42aa-9651-5e5749f4eba1", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "8cff92b1-cda6-4af4-b581-e220927973c2", "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": "c3a556b8-d69a-434f-8e6c-8a4638d5dd41", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "fa1c1ed3-026b-498b-a32f-efd6d396fc65" }, "suggested_date_start": "2024-04-16T15:48:40.1892354+00:00", "skill_id": "71b976f8-4fa8-41cf-90ae-110d64d18722", "skill_code": "sample string 32", "skill": { "id": "64362129-cc5e-4810-b983-6e39de149ff1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "98bc8948-c435-49f5-b50b-9d9b0c20319c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd740ce0-ec2c-41a4-9fd0-db23655387da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4305d76-35f8-4e3b-916c-9f1e824310d2", "db_currency_id": "55f526d9-bf9c-4682-85f7-1279a3320c1c", "db_language_id": "17d9d13c-3913-4c0f-a0da-2e27c86ac6df", "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-04-16T15:48:40.1892354+00:00" }, "modified_dateutc": "2024-04-16T15:48:40.1892354+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "6a86f5d7-0e11-401c-a2ae-354c4c9d89c2", "date_reported_by_company": "2024-04-16T15:48:40.1892354+00:00", "id2": 36, "company_id": "0a4cc97f-2fe6-4329-b19d-ddd521f764ab", "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": "96f85e28-09bc-4137-ae53-f81a937b657d", "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-04-16T15:48:40.1892354+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.