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": "12489c77-89e0-443b-85d4-161e8409f7cf", "_parent_id": "361bf5ad-c99a-44b8-91f1-47eb55f47b1d", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "d5e8335d-9597-48c0-821f-64dd1a4e39b1", "project_reference_back_office": "sample string 5", "project": { "id": "893c6826-5a4f-40f5-836e-07ec2a2ecfcd", "_parent_id": "29b46032-7d37-4835-a408-0d36a9aa0e78", "root_parent_id": "c86d0ef2-dc50-4b68-9bbf-b40901656918", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "53e94ae2-e7bd-485d-86a7-3adcfa1acd02", "equipment_family_code": "sample string 6", "equipment_family": { "id": "7e689866-1a0c-49e5-ba8e-7488d3bb4c46", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b382e1a4-0206-4c58-a1ad-bb0355947e54", "_parent_code": "sample string 6", "sales_organization_id": "ead51fba-ef4d-4fa0-aa25-5a0b768709f6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "equipment_model_id": "375cf08d-4670-49dd-a6df-25a78ab75a33", "equipment_model_code": "sample string 8", "equipment_model": { "id": "dbdb9a51-a297-42d2-b6ee-32a74e57a0da", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1270c4ec-a24e-499f-bbde-a6be4f84404c", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "42bbd4c3-ba1d-45f3-acf3-fc14b7f55547", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "e246fd2c-5889-4a3d-85c1-3dad210e3ab3", "sales_organization_code": "sample string 5", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "equipment_family_id": "5ead6599-d70e-4a9a-a007-7f1ac8839395", "equipment_family_code": "sample string 8", "equipment_family": { "id": "7e689866-1a0c-49e5-ba8e-7488d3bb4c46", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b382e1a4-0206-4c58-a1ad-bb0355947e54", "_parent_code": "sample string 6", "sales_organization_id": "ead51fba-ef4d-4fa0-aa25-5a0b768709f6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "date_in_production_since": "2024-12-20T04:32:27.4420222+00:00", "date_out_of_production_since": "2024-12-20T04:32:27.4420222+00:00", "date_end_support": "2024-12-20T04:32:27.4420222+00:00", "sales_organization_id": "75800ca1-5944-4124-b321-49ed4c488b49", "sales_organization_code": "sample string 13", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+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-20T04:32:27.4420222+00:00" }, "project_status_id": "fff0aa75-0590-4927-a7c7-2f367d1e4db4", "project_status_code": "sample string 10", "project_status": { "id": "d502a38a-41a0-4bbf-b4ca-28f36266d8d5", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "076ecfe0-d1c7-4554-a9a5-82592e36a2fe", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "company_id": "951779ee-baf0-45a2-b39b-673b56760421", "company_code": "sample string 12", "db_address_id": "7488c569-b480-4416-af73-b27f95a9125c", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "6e7be11a-dd75-4bd5-86ca-4b6685dbc9c3", "contact_reference_back_office": "sample string 17", "owner_user_id": "707ea63c-e144-4aa2-9819-2009460c42bc", "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-20T04:32:27.4420222+00:00", "date_create": "2024-12-20T04:32:27.4420222+00:00", "date_update": "2024-12-20T04:32:27.4420222+00:00", "updated_by_user_id": "9ec88fa3-8bcc-43a4-9406-8dd6ef1f4686", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-20T04:32:27.4420222+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-20T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-20T04:32:27.4420222+00:00", "date_last_job": "2024-12-20T04:32:27.4420222+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-20T04:32:27.4420222+00:00", "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00", "is_mobile_installation": true }, "job_type_id": "2344054c-b178-4285-a8b3-c9c9675db0bd", "job_type_code": "sample string 7", "job_type": { "id": "4d3f7064-6aed-462e-af5d-75f3c83821f7", "name": "sample string 2", "sales_organization_id": "b63d0c3a-5d35-4da3-8358-46b91a63eb4d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00", "code": "sample string 7" }, "job_priority_id": "c95ec77f-7afd-4b8f-a233-86b9ae39bd9e", "job_priority_code": "sample string 9", "job_priority": { "id": "21125621-2d48-4fe1-a02c-5ed214b9b241", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "3bd81c2f-af57-422f-83ea-f11f59285d4e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "job_status_id": "129832a8-3cb8-4122-b51c-27d041d28ba4", "job_status_code": "sample string 11", "db_address_id": "1cd99295-60fb-40d6-9e5d-28bcff40fd80", "contact_id": "8520befc-8734-4931-979f-c251d3c11408", "requested_by_company_id": "cb3af112-139f-4cac-a682-49d07a0cd92d", "requested_by_contact_id": "c36773a1-e9ac-45f1-83a9-18ddef401c81", "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-20T04:32:27.4420222+00:00", "due_date": "2024-12-20T04:32:27.4420222+00:00", "date_create": "2024-12-20T04:32:27.4420222+00:00", "date_update": "2024-12-20T04:32:27.4420222+00:00", "date_closed": "2024-12-20T04:32:27.4420222+00:00", "suggested_user_id": "3ccd10cf-5004-4b52-abdf-62e53dfbf589", "suggested_user_code": "sample string 29", "suggested_user": { "id": "18eda21f-aad9-44a3-9614-15670072b3ab", "db_language_id": "e5775dad-80ae-4868-be92-108cbed54b19", "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-20T04:32:27.4420222+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9afb59bb-abd6-485e-b753-392315d7d631", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "600ed044-8248-4c64-b209-25cc983f3f12", "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": "f309239e-f775-425c-bf8f-7a609c465d9b", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "76ddba75-c0ea-44d1-894a-6af3464d6524" }, "suggested_date_start": "2024-12-20T04:32:27.4420222+00:00", "skill_id": "3494be42-4b2e-4f96-9b63-4f1c8c28d49e", "skill_code": "sample string 32", "skill": { "id": "c0d2a3cf-68dc-4471-8714-2bfcf172745b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "283f71a9-cc71-4cac-ad4c-43258b8cd504", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5cc2799d-48be-4955-8aee-9076a884a8b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3ad115c6-f5e3-419c-847e-87ff4704e9a8", "db_currency_id": "d1632937-a07b-4ff1-a672-46fdc632929d", "db_language_id": "4ae82b17-4943-4c7d-b2ca-0272332bd8a1", "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-20T04:32:27.4420222+00:00" }, "modified_dateutc": "2024-12-20T04:32:27.4420222+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "3793e03c-2ae9-456f-9575-c9358936c932", "date_reported_by_company": "2024-12-20T04:32:27.4420222+00:00", "id2": 36, "company_id": "36d3d234-d4e5-4024-b560-0f07bea90045", "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": "6e432fa5-0691-427b-837b-58c35c9f7822", "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-20T04:32:27.4420222+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.