Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
API:t är en ren front för LimeCRM:s eget REST-API, och tillför ingen egen funktionalitet.
Livscykelstatus
Produktionssätts i samband med att LimeCRM går i produktion i augusti 2022.
Lösningsbeskrivning
LimeobjectAPI är en del av den karta som ligger här: 22-05 Nytt CRM och ärendehanteringssystem . I bilden nedan visas var i den stora kartan API:t hör hemma.
I kartan ingår en komponent (mikrotjänsten “LimeProxy-API) som i dagsläget ej är implementerad, då behovet av den kommer senare.
Notera att lösningen kräver dubbel autentisering. För att anropa API-GW krävs en Bearer token som hämtas utifrån följande anrop:
Code Block |
---|
curl -k -X POST https://api.sundsvall.se/token -d "grant_type=client_credentials" -H "Authorization: Basic Base64(consumer-key:consumer-secret)" |
Utöver detta har LimeCRM en egen api-nyckel som läggs i headern x-api-key (se dokumentation nedan).
Hantering av personuppgifter
I den mån personuppgifter förekommer i LimeCRM kommer dessa att gå att läsa ut via detta API.
API specifikation
Eftersom Lime inte har någon testmiljö finns inga API-nycklar mot Sandbox.
Swagger ui |
---|
{ "swagger": "2.0", "info": { "description": "## Introduction\nThe Limeobject API provides basic operations for creating, updating and deleting objects in a Lime CRM application.\n\n## Schema\nThe API can and should only be accessed over HTTPS. All data sent to the API should be in JSON format with the\n`application/json` content type set. Responses are sent in [JSON/HAL format](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n(`application/json+hal` media type) which in addition to plain JSON object data also includes hyperlinks to direct\nclients around the available resources.\n\nProperties that are missing values, e.g. relation properties without a related object are set to `null`. This is\nalso the way to unset relations.\n\nSystem properties are prefixed with an underscore, e.g. `_createdtime`. These properties are always read-only.\n\nAll date/time properties are specified in [ISO 8601 format](https://pypi.python.org/pypi/iso8601),\ne.g. `YYYY-MM-DDTHH:MM:SSZ` (time in UTC) or `YYYY-MM-DDTHH:MM:SS+hh:mm` (where `hh:mm` specifies the\ntime offset from UTC). Not specifying timezone information is valid but the result is undefined.\n\n## Authentication and authorization\nAPI keys are used to authenticate against the API. The key must be sent as the value of a header named\n`x-api-key` in every request. Example:\n```\ncurl -H \"x-api-key: ABC123\" https://example.com/my_app/api/v1\n```\nRequests that require authentication will in som cases return `404 Not Found` instead of `401 Unauthorized` in\norder to prevent leakage of application data to unauthorized users.\n\nAll requests are subject to the Lime CRM permission model. If access is denied for a certain operation on a\ncertain resource, `403 Forbidden` will be returned.\n\n## Error handling\nThe API uses standard HTTP status codes for error reporting. Some responses contain error objects, see the\nresponse for each operation for specifics.\n\n## Embedding\nSome operations support embedding of related information that would otherwise require additional requests to retrieve.\nEmbedding is done through the `_embed` query parameter.\n\n## Filtering\nThe `/{limetype}/` collection (e.g. `/company/`) endpoints support simple filtering queries. As an example,\nthe following query would retrieve companies based in Lund where the responsible coworker has id 1001:\n```\ncurl -H \"x-api-key: ABC123\" https://example.com/my_app/api/v1/limeobject/company/?city=Lund&responsible=1001\n```\nHow filtering works:\n - Equal sign (=) is always used to separate property name and condition value, ampersand (&) separates expressions.\n - Prefixes are used to change expression evaluation, supported prefixes: `not`, `max`, `min`.\n - AND logic is applied between expressions having different property names, i.e. filtering on `relation=prospect&region=south` will show all prospects in the southern region.\n - OR logic is applied between expressions having _the same_ property names, i.e. it is possible to filter on `relation=prospect&relation=customer` to retrieve both prospects and customers.\n - AND logic is applied between expressions having the same property names when used with the _not_ operator, i.e. `not-region=south&not-region=west` to retrieve objects neither in the south nor west regions.\n - String comparisons are always case-insensitive.\n\nAnother example which would retrieve deals that are not in status closed and where the quotation\ndate is before 2017-01-01 UTC:\n```\ncurl -H \"x-api-key: ABC123\" https://example.com/my_app/api/v1/limeobject/deal/?not-dealstatus=closed&max-quotationdate=2016-12-31T23:59Z\n```\n\n## Sorting\nThe `/{limetype}/` collection endpoints support sorting of the returned result. Currently the result can only\nbe sorted on a single property by specifying a valid property name for the `_sort` query parameter. The result\ncan be sorted in descending order by prefixing the property name with a minus sign.\n\n## Pagination\nThe `/{limetype}/` collection endpoints return multiple objects paginated to 10 items\nby default. The following next object page can be retrieved by following the `next` link provided in the response.\n\n## Documents and files\nDocument and file handling in Lime CRM are two separate concepts. Any limeobject having a _file_ property can\nreference a file object. The file object stores the actual binary file data and related metadata such as file size\nand file name. Creating a document object with an attached file therefore requires two operations:\n\n1. Create a new file (using the File API).\n2. Create a new limeobject (using the Limeobject API) and set the file property to the ID of the file created in the first step.\n\nThis also means that completely deleting a document and its attached file requires two steps (if you know\nboth the document and the file ids):\n\n1. Remove the document limeobject.\n2. Remove the file object (using the file API).\n\n## Unsupported features\nCurrently the following is not supported:\n - Many-to-many relations.\n", "version": "1.0.0", "title": "Limeobject API", "contact": { "name": "Lime by Lundalogik", "url": "https://www.lime-technologies.com/support/" } }, "host": "saas226.stadsbackenhttps://api.sundsvall.se", "basePath": "/lime_see_prod/api/v1/limeobject/", "schemes": [ "https", "http" ], "consumes": [ "application/json" ], "produces": [ "application/hal+json" ], "security": [ { "api_key": [] } ], "paths": { "/company/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve companies", "description": "Retrieves a paginated list of company objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Company" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Companies" ], "summary": "Create a new company.", "description": "Create a single company object.", "parameters": [ { "in": "body", "name": "Company", "description": "The company data to insert.", "required": true, "schema": { "$ref": "#/definitions/Company" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Company" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve a company.", "description": "Retrieves a single company object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the company to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Companies" ], "summary": "Update an existing company.", "description": "Updates a single company object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the company to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Company", "description": "The Company data to update.", "required": true, "schema": { "$ref": "#/definitions/Company" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Companies" ], "summary": "Delete a company.", "description": "Deletes a single company object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/coworker/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/person/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related persons.", "description": "Retrieves a paginated list of person objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Person" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/deal/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related deals.", "description": "Retrieves a paginated list of deal objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deal" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/history/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/document/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/invoice/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related invoices.", "description": "Retrieves a paginated list of invoice objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/invoicerow/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related invoice rows.", "description": "Retrieves a paginated list of invoice row objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice_Row" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/todo/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/helpdesk/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/company/{id}/consent/": { "get": { "tags": [ "Companies" ], "summary": "Retrieve related legal base & consent.", "description": "Retrieves a paginated list of legal base & consent objects related to a specific company. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent company.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Legal_base_&_consent" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve persons", "description": "Retrieves a paginated list of person objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Person" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Persons" ], "summary": "Create a new person.", "description": "Create a single person object.", "parameters": [ { "in": "body", "name": "Person", "description": "The person data to insert.", "required": true, "schema": { "$ref": "#/definitions/Person" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Person" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve a person.", "description": "Retrieves a single person object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the person to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Persons" ], "summary": "Update an existing person.", "description": "Updates a single person object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the person to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Person", "description": "The Person data to update.", "required": true, "schema": { "$ref": "#/definitions/Person" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Persons" ], "summary": "Delete a person.", "description": "Deletes a single person object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/company/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/history/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/document/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/todo/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/participant/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related participants.", "description": "Retrieves a paginated list of participant objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Participant" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/deal/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related deals.", "description": "Retrieves a paginated list of deal objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deal" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/helpdesk/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/person/{id}/consent/": { "get": { "tags": [ "Persons" ], "summary": "Retrieve related legal base & consent.", "description": "Retrieves a paginated list of legal base & consent objects related to a specific person. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent person.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Legal_base_&_consent" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve ", "description": "Retrieves a paginated list of helpdesk objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "helpdesk" ], "summary": "Create a new helpdesk.", "description": "Create a single helpdesk object.", "parameters": [ { "in": "body", "name": "helpdesk", "description": "The helpdesk data to insert.", "required": true, "schema": { "$ref": "#/definitions/helpdesk" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a helpdesk.", "description": "Retrieves a single helpdesk object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdesk to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "helpdesk" ], "summary": "Update an existing helpdesk.", "description": "Updates a single helpdesk object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdesk to update.", "required": true, "type": "integer" }, { "in": "body", "name": "helpdesk", "description": "The helpdesk data to update.", "required": true, "schema": { "$ref": "#/definitions/helpdesk" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "helpdesk" ], "summary": "Delete a helpdesk.", "description": "Deletes a single helpdesk object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/company/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/person/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/deal/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related deal.", "description": "Retrieves the related deal object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "No deal object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/businessunit/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related businessunit.", "description": "Retrieves the related businessunit object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/businessunit" } }, "404": { "description": "No businessunit object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/helpdeskcategory/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related helpdeskcategory.", "description": "Retrieves the related helpdeskcategory object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdeskcategory" } }, "404": { "description": "No helpdeskcategory object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/mainhelpdesktype/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related helpdesk type.", "description": "Retrieves the related helpdesk type object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Helpdesk_type" } }, "404": { "description": "No helpdesk type object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/office/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related office.", "description": "Retrieves the related office object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Office" } }, "404": { "description": "No office object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/coworker/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/history/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific helpdesk. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/document/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific helpdesk. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/todo/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific helpdesk. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesk/{id}/checklist_item/": { "get": { "tags": [ "helpdesk" ], "summary": "Retrieve related checklist.", "description": "Retrieves a paginated list of checklist objects related to a specific helpdesk. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Checklist" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve deals", "description": "Retrieves a paginated list of deal objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deal" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Deals" ], "summary": "Create a new deal.", "description": "Create a single deal object.", "parameters": [ { "in": "body", "name": "Deal", "description": "The deal data to insert.", "required": true, "schema": { "$ref": "#/definitions/Deal" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Deal" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve a deal.", "description": "Retrieves a single deal object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the deal to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Deals" ], "summary": "Update an existing deal.", "description": "Updates a single deal object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the deal to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Deal", "description": "The Deal data to update.", "required": true, "schema": { "$ref": "#/definitions/Deal" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Deals" ], "summary": "Delete a deal.", "description": "Deletes a single deal object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/company/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/person/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/coworker/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/todo2/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve a related to-do.", "description": "Retrieves the related to-do object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/To-do" } }, "404": { "description": "No to-do object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/history/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific deal. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/document/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific deal. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/todo/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific deal. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/deal/{id}/helpdesk/": { "get": { "tags": [ "Deals" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific deal. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent deal.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve to-dos", "description": "Retrieves a paginated list of to-do objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "To-dos" ], "summary": "Create a new to-do.", "description": "Create a single to-do object.", "parameters": [ { "in": "body", "name": "To-do", "description": "The to-do data to insert.", "required": true, "schema": { "$ref": "#/definitions/To-do" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/To-do" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a to-do.", "description": "Retrieves a single to-do object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the to-do to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/To-do" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "To-dos" ], "summary": "Update an existing to-do.", "description": "Updates a single to-do object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the to-do to update.", "required": true, "type": "integer" }, { "in": "body", "name": "To-do", "description": "The To-do data to update.", "required": true, "schema": { "$ref": "#/definitions/To-do" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/To-do" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "To-dos" ], "summary": "Delete a to-do.", "description": "Deletes a single to-do object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/coworker/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/person/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/helpdesk/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related helpdesk.", "description": "Retrieves the related helpdesk object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "No helpdesk object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/company/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/deal/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related deal.", "description": "Retrieves the related deal object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "No deal object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/campaign/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related marketing activity.", "description": "Retrieves the related marketing activity object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "No marketing activity object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/solutionimprovement/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve a related solution improvement.", "description": "Retrieves the related solution improvement object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "404": { "description": "No solution improvement object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/todo/{id}/deal2/": { "get": { "tags": [ "To-dos" ], "summary": "Retrieve related deals.", "description": "Retrieves a paginated list of deal objects related to a specific to-do. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent to-do.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deal" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/": { "get": { "tags": [ "History" ], "summary": "Retrieve history", "description": "Retrieves a paginated list of history objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "History" ], "summary": "Create a new history.", "description": "Create a single history object.", "parameters": [ { "in": "body", "name": "History", "description": "The history data to insert.", "required": true, "schema": { "$ref": "#/definitions/History" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/History" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/": { "get": { "tags": [ "History" ], "summary": "Retrieve a history.", "description": "Retrieves a single history object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the history to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/History" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "History" ], "summary": "Update an existing history.", "description": "Updates a single history object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the history to update.", "required": true, "type": "integer" }, { "in": "body", "name": "History", "description": "The History data to update.", "required": true, "schema": { "$ref": "#/definitions/History" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/History" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "History" ], "summary": "Delete a history.", "description": "Deletes a single history object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/company/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/person/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/coworker/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/deal/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related deal.", "description": "Retrieves the related deal object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "No deal object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/campaign/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related marketing activity.", "description": "Retrieves the related marketing activity object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "No marketing activity object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/helpdesk/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related helpdesk.", "description": "Retrieves the related helpdesk object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "No helpdesk object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/document/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related document.", "description": "Retrieves the related document object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Document" } }, "404": { "description": "No document object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/history/{id}/solutionimprovement/": { "get": { "tags": [ "History" ], "summary": "Retrieve a related solution improvement.", "description": "Retrieves the related solution improvement object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent history.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "404": { "description": "No solution improvement object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve documents", "description": "Retrieves a paginated list of document objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Documents" ], "summary": "Create a new document.", "description": "Create a single document object.", "parameters": [ { "in": "body", "name": "Document", "description": "The document data to insert.", "required": true, "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Document" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a document.", "description": "Retrieves a single document object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the document to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Document" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Documents" ], "summary": "Update an existing document.", "description": "Updates a single document object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the document to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Document", "description": "The Document data to update.", "required": true, "schema": { "$ref": "#/definitions/Document" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Document" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Documents" ], "summary": "Delete a document.", "description": "Deletes a single document object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/company/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/person/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/coworker/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/deal/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related deal.", "description": "Retrieves the related deal object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Deal" } }, "404": { "description": "No deal object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/helpdesk/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related helpdesk.", "description": "Retrieves the related helpdesk object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "No helpdesk object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/campaign/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related marketing activity.", "description": "Retrieves the related marketing activity object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "No marketing activity object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/solutionimprovement/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve a related solution improvement.", "description": "Retrieves the related solution improvement object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "404": { "description": "No solution improvement object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/document/{id}/history/": { "get": { "tags": [ "Documents" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific document. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent document.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve marketing activities", "description": "Retrieves a paginated list of marketing activity objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Marketing_activity" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Marketing activities" ], "summary": "Create a new marketing activity.", "description": "Create a single marketing activity object.", "parameters": [ { "in": "body", "name": "Marketing activity", "description": "The marketing activity data to insert.", "required": true, "schema": { "$ref": "#/definitions/Marketing_activity" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve a marketing activity.", "description": "Retrieves a single marketing activity object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the marketing activity to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Marketing activities" ], "summary": "Update an existing marketing activity.", "description": "Updates a single marketing activity object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the marketing activity to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Marketing activity", "description": "The Marketing activity data to update.", "required": true, "schema": { "$ref": "#/definitions/Marketing_activity" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Marketing activities" ], "summary": "Delete a marketing activity.", "description": "Deletes a single marketing activity object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/coworker/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent marketing activity.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/participant/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve related participants.", "description": "Retrieves a paginated list of participant objects related to a specific marketing activity. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent marketing activity.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Participant" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/history/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific marketing activity. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent marketing activity.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/document/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific marketing activity. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent marketing activity.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/campaign/{id}/todo/": { "get": { "tags": [ "Marketing activities" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific marketing activity. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent marketing activity.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/participant/": { "get": { "tags": [ "Participants" ], "summary": "Retrieve participants", "description": "Retrieves a paginated list of participant objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Participant" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Participants" ], "summary": "Create a new participant.", "description": "Create a single participant object.", "parameters": [ { "in": "body", "name": "Participant", "description": "The participant data to insert.", "required": true, "schema": { "$ref": "#/definitions/Participant" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Participant" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/participant/{id}/": { "get": { "tags": [ "Participants" ], "summary": "Retrieve a participant.", "description": "Retrieves a single participant object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the participant to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Participant" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Participants" ], "summary": "Update an existing participant.", "description": "Updates a single participant object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the participant to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Participant", "description": "The Participant data to update.", "required": true, "schema": { "$ref": "#/definitions/Participant" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Participant" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Participants" ], "summary": "Delete a participant.", "description": "Deletes a single participant object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/participant/{id}/person/": { "get": { "tags": [ "Participants" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent participant.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/participant/{id}/campaign/": { "get": { "tags": [ "Participants" ], "summary": "Retrieve a related marketing activity.", "description": "Retrieves the related marketing activity object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent participant.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Marketing_activity" } }, "404": { "description": "No marketing activity object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve offices", "description": "Retrieves a paginated list of office objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Office" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Offices" ], "summary": "Create a new office.", "description": "Create a single office object.", "parameters": [ { "in": "body", "name": "Office", "description": "The office data to insert.", "required": true, "schema": { "$ref": "#/definitions/Office" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Office" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/{id}/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve a office.", "description": "Retrieves a single office object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the office to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Office" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Offices" ], "summary": "Update an existing office.", "description": "Updates a single office object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the office to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Office", "description": "The Office data to update.", "required": true, "schema": { "$ref": "#/definitions/Office" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Office" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Offices" ], "summary": "Delete a office.", "description": "Deletes a single office object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/{id}/businessunit/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve a related businessunit.", "description": "Retrieves the related businessunit object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent office.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/businessunit" } }, "404": { "description": "No businessunit object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/{id}/coworker/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve related coworkers.", "description": "Retrieves a paginated list of coworker objects related to a specific office. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent office.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Coworker" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/{id}/helpdesktype/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve related helpdesk type.", "description": "Retrieves a paginated list of helpdesk type objects related to a specific office. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent office.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Helpdesk_type" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/office/{id}/helpdesk/": { "get": { "tags": [ "Offices" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific office. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent office.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/infotiles/": { "get": { "tags": [ "InfoTiles" ], "summary": "Retrieve infotiles", "description": "Retrieves a paginated list of infotile objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/InfoTile" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "InfoTiles" ], "summary": "Create a new infotile.", "description": "Create a single infotile object.", "parameters": [ { "in": "body", "name": "InfoTile", "description": "The infotile data to insert.", "required": true, "schema": { "$ref": "#/definitions/InfoTile" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/InfoTile" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/infotiles/{id}/": { "get": { "tags": [ "InfoTiles" ], "summary": "Retrieve a infotile.", "description": "Retrieves a single infotile object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the infotile to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/InfoTile" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "InfoTiles" ], "summary": "Update an existing infotile.", "description": "Updates a single infotile object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the infotile to update.", "required": true, "type": "integer" }, { "in": "body", "name": "InfoTile", "description": "The InfoTile data to update.", "required": true, "schema": { "$ref": "#/definitions/InfoTile" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/InfoTile" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "InfoTiles" ], "summary": "Delete a infotile.", "description": "Deletes a single infotile object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/infotiles/{id}/coworker/": { "get": { "tags": [ "InfoTiles" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent infotile.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve solution improvements", "description": "Retrieves a paginated list of solution improvement objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Solution_improvement" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Solution improvements" ], "summary": "Create a new solution improvement.", "description": "Create a single solution improvement object.", "parameters": [ { "in": "body", "name": "Solution improvement", "description": "The solution improvement data to insert.", "required": true, "schema": { "$ref": "#/definitions/Solution_improvement" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve a solution improvement.", "description": "Retrieves a single solution improvement object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the solution improvement to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Solution improvements" ], "summary": "Update an existing solution improvement.", "description": "Updates a single solution improvement object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the solution improvement to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Solution improvement", "description": "The Solution improvement data to update.", "required": true, "schema": { "$ref": "#/definitions/Solution_improvement" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Solution_improvement" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Solution improvements" ], "summary": "Delete a solution improvement.", "description": "Deletes a single solution improvement object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/coworkercreatedby/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent solution improvement.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/coworker/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent solution improvement.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/history/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific solution improvement. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent solution improvement.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/todo/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific solution improvement. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent solution improvement.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/solutionimprovement/{id}/document/": { "get": { "tags": [ "Solution improvements" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific solution improvement. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent solution improvement.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/localize/": { "get": { "tags": [ "Localizations" ], "summary": "Retrieve localizations", "description": "Retrieves a paginated list of localization objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Localization" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Localizations" ], "summary": "Create a new localization.", "description": "Create a single localization object.", "parameters": [ { "in": "body", "name": "Localization", "description": "The localization data to insert.", "required": true, "schema": { "$ref": "#/definitions/Localization" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Localization" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/localize/{id}/": { "get": { "tags": [ "Localizations" ], "summary": "Retrieve a localization.", "description": "Retrieves a single localization object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the localization to retrieve.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Localization" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Localizations" ], "summary": "Update an existing localization.", "description": "Updates a single localization object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the localization to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Localization", "description": "The Localization data to update.", "required": true, "schema": { "$ref": "#/definitions/Localization" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Localization" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Localizations" ], "summary": "Delete a localization.", "description": "Deletes a single localization object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoice/": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve invoices", "description": "Retrieves a paginated list of invoice objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Invoices" ], "summary": "Create a new invoice.", "description": "Create a single invoice object.", "parameters": [ { "in": "body", "name": "Invoice", "description": "The invoice data to insert.", "required": true, "schema": { "$ref": "#/definitions/Invoice" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Invoice" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoice/{id}/": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve a invoice.", "description": "Retrieves a single invoice object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Invoice" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Invoices" ], "summary": "Update an existing invoice.", "description": "Updates a single invoice object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Invoice", "description": "The Invoice data to update.", "required": true, "schema": { "$ref": "#/definitions/Invoice" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Invoice" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Invoices" ], "summary": "Delete a invoice.", "description": "Deletes a single invoice object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoice/{id}/company/": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent invoice.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoice/{id}/coworker/": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent invoice.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoice/{id}/invoicerow/": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve related invoice rows.", "description": "Retrieves a paginated list of invoice row objects related to a specific invoice. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent invoice.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice_Row" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoicerow/": { "get": { "tags": [ "Invoice rows" ], "summary": "Retrieve invoice rows", "description": "Retrieves a paginated list of invoice row objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice_Row" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Invoice rows" ], "summary": "Create a new invoice row.", "description": "Create a single invoice row object.", "parameters": [ { "in": "body", "name": "Invoice Row", "description": "The invoice row data to insert.", "required": true, "schema": { "$ref": "#/definitions/Invoice_Row" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Invoice_Row" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoicerow/{id}/": { "get": { "tags": [ "Invoice rows" ], "summary": "Retrieve a invoice row.", "description": "Retrieves a single invoice row object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice row to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Invoice_Row" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Invoice rows" ], "summary": "Update an existing invoice row.", "description": "Updates a single invoice row object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the invoice row to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Invoice Row", "description": "The Invoice Row data to update.", "required": true, "schema": { "$ref": "#/definitions/Invoice_Row" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Invoice_Row" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Invoice rows" ], "summary": "Delete a invoice row.", "description": "Deletes a single invoice row object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoicerow/{id}/company/": { "get": { "tags": [ "Invoice rows" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent invoice row.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/invoicerow/{id}/invoice/": { "get": { "tags": [ "Invoice rows" ], "summary": "Retrieve a related invoice.", "description": "Retrieves the related invoice object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent invoice row.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Invoice" } }, "404": { "description": "No invoice object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve coworkers", "description": "Retrieves a paginated list of coworker objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Coworker" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Coworkers" ], "summary": "Create a new coworker.", "description": "Create a single coworker object.", "parameters": [ { "in": "body", "name": "Coworker", "description": "The coworker data to insert.", "required": true, "schema": { "$ref": "#/definitions/Coworker" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Coworker" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve a coworker.", "description": "Retrieves a single coworker object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the coworker to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Coworkers" ], "summary": "Update an existing coworker.", "description": "Updates a single coworker object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the coworker to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Coworker", "description": "The Coworker data to update.", "required": true, "schema": { "$ref": "#/definitions/Coworker" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Coworkers" ], "summary": "Delete a coworker.", "description": "Deletes a single coworker object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/office/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve a related office.", "description": "Retrieves the related office object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Office" } }, "404": { "description": "No office object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/todo/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related to-dos.", "description": "Retrieves a paginated list of to-do objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/To-do" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/history/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related history.", "description": "Retrieves a paginated list of history objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/History" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/company/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related companies.", "description": "Retrieves a paginated list of company objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Company" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/helpdesk/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/document/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related documents.", "description": "Retrieves a paginated list of document objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Document" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/campaign/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related marketing activities.", "description": "Retrieves a paginated list of marketing activity objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Marketing_activity" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/deal/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related deals.", "description": "Retrieves a paginated list of deal objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deal" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/solutionimprovement/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related solution improvements.", "description": "Retrieves a paginated list of solution improvement objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Solution_improvement" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/solutionimprovementcreatedby/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related solution improvements.", "description": "Retrieves a paginated list of solution improvement objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Solution_improvement" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/invoice/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related invoices.", "description": "Retrieves a paginated list of invoice objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invoice" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/infotiles/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related infotiles.", "description": "Retrieves a paginated list of infotile objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/InfoTile" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/coworker/{id}/checklist_item/": { "get": { "tags": [ "Coworkers" ], "summary": "Retrieve related checklist.", "description": "Retrieves a paginated list of checklist objects related to a specific coworker. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent coworker.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Checklist" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/businessunit/": { "get": { "tags": [ "businessunit" ], "summary": "Retrieve ", "description": "Retrieves a paginated list of businessunit objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/businessunit" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "businessunit" ], "summary": "Create a new businessunit.", "description": "Create a single businessunit object.", "parameters": [ { "in": "body", "name": "businessunit", "description": "The businessunit data to insert.", "required": true, "schema": { "$ref": "#/definitions/businessunit" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/businessunit" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/businessunit/{id}/": { "get": { "tags": [ "businessunit" ], "summary": "Retrieve a businessunit.", "description": "Retrieves a single businessunit object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the businessunit to retrieve.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/businessunit" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "businessunit" ], "summary": "Update an existing businessunit.", "description": "Updates a single businessunit object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the businessunit to update.", "required": true, "type": "integer" }, { "in": "body", "name": "businessunit", "description": "The businessunit data to update.", "required": true, "schema": { "$ref": "#/definitions/businessunit" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/businessunit" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "businessunit" ], "summary": "Delete a businessunit.", "description": "Deletes a single businessunit object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/businessunit/{id}/heldeskcategory/": { "get": { "tags": [ "businessunit" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdeskcategory objects related to a specific businessunit. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent businessunit.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdeskcategory" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/businessunit/{id}/helpdesk/": { "get": { "tags": [ "businessunit" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific businessunit. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent businessunit.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/businessunit/{id}/office/": { "get": { "tags": [ "businessunit" ], "summary": "Retrieve related offices.", "description": "Retrieves a paginated list of office objects related to a specific businessunit. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent businessunit.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Office" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdeskcategory/": { "get": { "tags": [ "helpdeskcategory" ], "summary": "Retrieve ", "description": "Retrieves a paginated list of helpdeskcategory objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdeskcategory" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "helpdeskcategory" ], "summary": "Create a new helpdeskcategory.", "description": "Create a single helpdeskcategory object.", "parameters": [ { "in": "body", "name": "helpdeskcategory", "description": "The helpdeskcategory data to insert.", "required": true, "schema": { "$ref": "#/definitions/helpdeskcategory" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/helpdeskcategory" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdeskcategory/{id}/": { "get": { "tags": [ "helpdeskcategory" ], "summary": "Retrieve a helpdeskcategory.", "description": "Retrieves a single helpdeskcategory object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdeskcategory to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdeskcategory" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "helpdeskcategory" ], "summary": "Update an existing helpdeskcategory.", "description": "Updates a single helpdeskcategory object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdeskcategory to update.", "required": true, "type": "integer" }, { "in": "body", "name": "helpdeskcategory", "description": "The helpdeskcategory data to update.", "required": true, "schema": { "$ref": "#/definitions/helpdeskcategory" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/helpdeskcategory" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "helpdeskcategory" ], "summary": "Delete a helpdeskcategory.", "description": "Deletes a single helpdeskcategory object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdeskcategory/{id}/businessunit/": { "get": { "tags": [ "helpdeskcategory" ], "summary": "Retrieve a related businessunit.", "description": "Retrieves the related businessunit object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdeskcategory.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/businessunit" } }, "404": { "description": "No businessunit object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdeskcategory/{id}/helpdesktype/": { "get": { "tags": [ "helpdeskcategory" ], "summary": "Retrieve related helpdesk type.", "description": "Retrieves a paginated list of helpdesk type objects related to a specific helpdeskcategory. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdeskcategory.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Helpdesk_type" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdeskcategory/{id}/helpdesk/": { "get": { "tags": [ "helpdeskcategory" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific helpdeskcategory. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdeskcategory.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesktype/": { "get": { "tags": [ "Helpdesk type" ], "summary": "Retrieve helpdesk type", "description": "Retrieves a paginated list of helpdesk type objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Helpdesk_type" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Helpdesk type" ], "summary": "Create a new helpdesk type.", "description": "Create a single helpdesk type object.", "parameters": [ { "in": "body", "name": "Helpdesk type", "description": "The helpdesk type data to insert.", "required": true, "schema": { "$ref": "#/definitions/Helpdesk_type" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Helpdesk_type" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesktype/{id}/": { "get": { "tags": [ "Helpdesk type" ], "summary": "Retrieve a helpdesk type.", "description": "Retrieves a single helpdesk type object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdesk type to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Helpdesk_type" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Helpdesk type" ], "summary": "Update an existing helpdesk type.", "description": "Updates a single helpdesk type object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the helpdesk type to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Helpdesk type", "description": "The Helpdesk type data to update.", "required": true, "schema": { "$ref": "#/definitions/Helpdesk_type" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Helpdesk_type" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Helpdesk type" ], "summary": "Delete a helpdesk type.", "description": "Deletes a single helpdesk type object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesktype/{id}/office/": { "get": { "tags": [ "Helpdesk type" ], "summary": "Retrieve a related office.", "description": "Retrieves the related office object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk type.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Office" } }, "404": { "description": "No office object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesktype/{id}/helpdeskcategory/": { "get": { "tags": [ "Helpdesk type" ], "summary": "Retrieve a related helpdeskcategory.", "description": "Retrieves the related helpdeskcategory object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk type.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdeskcategory" } }, "404": { "description": "No helpdeskcategory object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/helpdesktype/{id}/helpdesk/": { "get": { "tags": [ "Helpdesk type" ], "summary": "Retrieve related .", "description": "Retrieves a paginated list of helpdesk objects related to a specific helpdesk type. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent helpdesk type.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/helpdesk" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consent/": { "get": { "tags": [ "Legal base & consent" ], "summary": "Retrieve legal base & consent", "description": "Retrieves a paginated list of legal base & consent objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Legal_base_&_consent" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Legal base & consent" ], "summary": "Create a new legal base & consent.", "description": "Create a single legal base & consent object.", "parameters": [ { "in": "body", "name": "Legal base & consent", "description": "The legal base & consent data to insert.", "required": true, "schema": { "$ref": "#/definitions/Legal_base_&_consent" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Legal_base_&_consent" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consent/{id}/": { "get": { "tags": [ "Legal base & consent" ], "summary": "Retrieve a legal base & consent.", "description": "Retrieves a single legal base & consent object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the legal base & consent to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Legal_base_&_consent" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Legal base & consent" ], "summary": "Update an existing legal base & consent.", "description": "Updates a single legal base & consent object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the legal base & consent to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Legal base & consent", "description": "The Legal base & consent data to update.", "required": true, "schema": { "$ref": "#/definitions/Legal_base_&_consent" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Legal_base_&_consent" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Legal base & consent" ], "summary": "Delete a legal base & consent.", "description": "Deletes a single legal base & consent object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consent/{id}/consenttype/": { "get": { "tags": [ "Legal base & consent" ], "summary": "Retrieve a related consent type.", "description": "Retrieves the related consent type object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent legal base & consent.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Consent_type" } }, "404": { "description": "No consent type object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consent/{id}/person/": { "get": { "tags": [ "Legal base & consent" ], "summary": "Retrieve a related person.", "description": "Retrieves the related person object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent legal base & consent.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Person" } }, "404": { "description": "No person object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consent/{id}/company/": { "get": { "tags": [ "Legal base & consent" ], "summary": "Retrieve a related company.", "description": "Retrieves the related company object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent legal base & consent.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Company" } }, "404": { "description": "No company object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve checklist", "description": "Retrieves a paginated list of checklist objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Checklist" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Checklist" ], "summary": "Create a new checklist.", "description": "Create a single checklist object.", "parameters": [ { "in": "body", "name": "Checklist", "description": "The checklist data to insert.", "required": true, "schema": { "$ref": "#/definitions/Checklist" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Checklist" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve a checklist.", "description": "Retrieves a single checklist object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the checklist to retrieve.", "required": true, "type": "integer" }, { "name": "_embed", "in": "query", "description": "Include data for related objects of the specified type.", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Checklist" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Checklist" ], "summary": "Update an existing checklist.", "description": "Updates a single checklist object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the checklist to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Checklist", "description": "The Checklist data to update.", "required": true, "schema": { "$ref": "#/definitions/Checklist" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Checklist" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Checklist" ], "summary": "Delete a checklist.", "description": "Deletes a single checklist object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/coworker/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve a related coworker.", "description": "Retrieves the related coworker object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent checklist.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Coworker" } }, "404": { "description": "No coworker object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/checklist_item_previous/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve a related checklist.", "description": "Retrieves the related checklist object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent checklist.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Checklist" } }, "404": { "description": "No checklist object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/history/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve a related history.", "description": "Retrieves the related history object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent checklist.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/History" } }, "404": { "description": "No history object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/helpdesk/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve a related helpdesk.", "description": "Retrieves the related helpdesk object, if any.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent checklist.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/helpdesk" } }, "404": { "description": "No helpdesk object has been set for this relation." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/checklist_item/{id}/checklist_items_next/": { "get": { "tags": [ "Checklist" ], "summary": "Retrieve related checklist.", "description": "Retrieves a paginated list of checklist objects related to a specific checklist. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent checklist.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Checklist" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consenttype/": { "get": { "tags": [ "Consent type" ], "summary": "Retrieve consent type", "description": "Retrieves a paginated list of consent type objects. The result contains all available properties.", "parameters": [ { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Consent_type" } } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "post": { "tags": [ "Consent type" ], "summary": "Create a new consent type.", "description": "Create a single consent type object.", "parameters": [ { "in": "body", "name": "Consent type", "description": "The consent type data to insert.", "required": true, "schema": { "$ref": "#/definitions/Consent_type" } } ], "responses": { "201": { "description": "A JSON representation of the created object.", "schema": { "$ref": "#/definitions/Consent_type" } }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consenttype/{id}/": { "get": { "tags": [ "Consent type" ], "summary": "Retrieve a consent type.", "description": "Retrieves a single consent type object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the consent type to retrieve.", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A JSON representation of the requested object.", "schema": { "$ref": "#/definitions/Consent_type" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "put": { "tags": [ "Consent type" ], "summary": "Update an existing consent type.", "description": "Updates a single consent type object having the specified id. Note that partial objects (i.e. without all properties set) can be specified.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the consent type to update.", "required": true, "type": "integer" }, { "in": "body", "name": "Consent type", "description": "The Consent type data to update.", "required": true, "schema": { "$ref": "#/definitions/Consent_type" } } ], "responses": { "200": { "description": "A JSON representation of the updated (full) object.", "schema": { "$ref": "#/definitions/Consent_type" } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } }, "delete": { "tags": [ "Consent type" ], "summary": "Delete a consent type.", "description": "Deletes a single consent type object having the specified id.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the object to delete.", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Success. No content returned." }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } }, "/consenttype/{id}/consent/": { "get": { "tags": [ "Consent type" ], "summary": "Retrieve related legal base & consent.", "description": "Retrieves a paginated list of legal base & consent objects related to a specific consent type. The result contains all available properties.", "parameters": [ { "name": "id", "in": "path", "description": "The id of the parent consent type.", "required": true, "type": "integer" }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "required": false, "type": "integer", "default": 10, "maximum": 50, "minimum": 1 }, { "name": "_sort", "in": "query", "description": "Name of a (single) property to sort on. To sort in descending order, prefix with a '-' sign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "An array of objects.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Legal_base_&_consent" } } }, "404": { "description": "Limeobject not found." } }, "security": [ { "default": [] } ], "x-auth-type": "Application & Application User", "x-throttling-tier": "Unlimited", "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false } } } }, "securityDefinitions": { "api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "default": { "type": "oauth2", "authorizationUrl": "https://test.com", "flow": "implicit" } }, "definitions": { "Company": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Company name" }, "buyingstatus": { "type": "object", "title": "Buying status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "notinterested", "prospect", "active", "excustomer", "inactive" ] }, "text": { "type": "string" } } }, "coworker": { "type": "integer", "title": "Responsible" }, "postaladdress1": { "type": "string", "title": "Postal address" }, "visitingaddress1": { "type": "string", "title": "Visiting address" }, "postaladdress2": { "type": "string", "title": "Postal address 2" }, "visitingaddress2": { "type": "string", "title": "Visiting address 2" }, "postalzipcode": { "type": "string", "title": "Postal zip code" }, "postalcity": { "type": "string", "title": "Postal city" }, "visitingzipcode": { "type": "string", "title": "Visiting zip code" }, "visitingcity": { "type": "string", "title": "Visiting city" }, "country": { "type": "string", "title": "Country" }, "invoiceaddress1": { "type": "string", "title": "Invoice address 1" }, "invoiceaddress2": { "type": "string", "title": "Invoice address 2" }, "invoicezipcode": { "type": "string", "title": "Invoice zipcode" }, "invoicecity": { "type": "string", "title": "Invoice city" }, "fullpostaladdress": { "type": "string", "title": "Complete postal address" }, "fullvisitingaddress": { "type": "string", "title": "Complete visiting address" }, "fullinvoiceaddress": { "type": "string", "title": "Complete invoice address" }, "phone": { "type": "string", "title": "Telephone" }, "email": { "type": "string", "title": "Email" }, "www": { "type": "string", "title": "Homepage" }, "registrationno": { "type": "string", "title": "Registration number" }, "emailinvoice": { "type": "string", "title": "Invoice email" }, "expireddate": { "type": "string", "format": "date-time", "title": "Last date for anonymization" }, "anonymizeddate": { "type": "string", "format": "date-time", "title": "Anonymize date" }, "erp_id": { "type": "string", "title": "Customer number ERP" }, "erp_status": { "type": "object", "title": "Status ERP integration", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "readyforfirstsync", "updatesmade", "inprocess", "synced", "error" ] }, "text": { "type": "string" } } }, "erp_turnover_yearnow": { "type": "string", "title": "Turnover this year" }, "erp_turnover_lastyeartodate": { "type": "string", "title": "Turnover LYTD" }, "erp_turnover_lastyear": { "type": "string", "title": "Turnover last year" }, "erp_salestrend": { "type": "object", "title": "Sales trend", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "increasing", "steady", "decreasing" ] }, "text": { "type": "string" } } }, "erp_ytdgrowth": { "type": "string", "title": "YTD growth (%)" }, "erp_errormessage": { "type": "string", "title": "Error message ERP integration" }, "erp_firstsynced": { "type": "string", "format": "date-time", "title": "First sync ERP integration" }, "erp_lastsynced": { "type": "string", "format": "date-time", "title": "Last sync ERP integration" } } }, "Person": { "type": "object", "required": [ "firstname" ], "properties": { "id": { "type": "integer", "readOnly": true }, "firstname": { "type": "string", "title": "First name" }, "lastname": { "type": "string", "title": "Last name" }, "name": { "type": "string", "title": "Name" }, "phone": { "type": "string", "title": "Direct phone" }, "mobilephone": { "type": "string", "title": "Mobile phone" }, "email": { "type": "string", "title": "Email" }, "position": { "type": "string", "title": "Position" }, "inactive": { "type": "boolean", "title": "Inactive" }, "company": { "type": "integer", "title": "Company" }, "expireddate": { "type": "string", "format": "date-time", "title": "Last date for anonymization" }, "anonymizeddate": { "type": "string", "format": "date-time", "title": "Anonymize date" } } }, "helpdesk": { "type": "object", "required": [ "title" ], "properties": { "id": { "type": "integer", "readOnly": true }, "helpdeskno": { "type": "integer", "title": "helpdeskno" }, "helpdeskstatus": { "type": "object", "title": "Helpdesk status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "received", "enum": [ "closed", "ongoing", "parked", "received", "returned" ] }, "text": { "type": "string" } } }, "company": { "type": "integer", "title": "company" }, "person": { "type": "integer", "title": "person" }, "priority": { "type": "object", "title": "priority", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "normal", "enum": [ "empty", "normal", "panic" ] }, "text": { "type": "string" } } }, "receivedthrough": { "type": "object", "title": "receivedthrough", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "mail", "email", "form", "phone" ] }, "text": { "type": "string" } } }, "fromaddress": { "type": "string", "title": "fromaddress" }, "email": { "type": "string", "title": "Email customer" }, "emailtemplate": { "type": "string", "title": "emailtemplate" }, "deal": { "type": "integer", "title": "Deals" }, "address": { "type": "string", "title": "address" }, "title": { "type": "string", "title": "title" }, "description": { "type": "string", "title": "description" }, "businessunit": { "type": "integer", "title": "businessunit" }, "helpdeskcategory": { "type": "integer", "title": "helpdeskcategory" }, "mainhelpdesktype": { "type": "integer", "title": "mainhelpdesktype" }, "office": { "type": "integer", "title": "office" }, "coworker": { "type": "integer", "title": "coworker" }, "unreadhistory": { "type": "object", "title": "unreadhistory", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "unread" ] }, "text": { "type": "string" } } }, "registered": { "type": "string", "format": "date-time", "title": "Registered" }, "startdate": { "type": "string", "format": "date-time", "title": "startdate" }, "parkeddate": { "type": "string", "format": "date-time", "title": "parkeddate" }, "enddate": { "type": "string", "format": "date-time", "title": "enddate" }, "deadlinedate": { "type": "string", "format": "date-time", "title": "deadlinedate" }, "sortfield": { "type": "string", "title": "sortfield" }, "checklist_item_current": { "type": "string", "title": "checklist_item_current" }, "checklist_item_deadline": { "type": "string", "format": "date-time", "title": "checklist_item_deadline" }, "checklist_template": { "type": "string", "title": "checklist_template" } } }, "Deal": { "type": "object", "required": [ "name", "probability", "value", "weightedvalue" ], "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Deal name" }, "company": { "type": "integer", "title": "Company" }, "person": { "type": "integer", "title": "Responsible at customer" }, "coworker": { "type": "integer", "title": "Responsible salesperson" }, "dealstatus": { "type": "object", "title": "Status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "contact", "enum": [ "contact", "requirement", "tender", "agreement", "onhold", "rejection" ] }, "text": { "type": "string" } } }, "value": { "type": "string", "title": "Value" }, "probability": { "type": "string", "title": "Probability" }, "weightedvalue": { "type": "string", "title": "Weighted value" }, "wonlostreason": { "type": "string", "title": "Won/Lost reason" }, "quotesent": { "type": "string", "format": "date", "title": "Quote sent" }, "expecteddate": { "type": "string", "title": "Expected order" }, "closeddate": { "type": "string", "format": "date", "title": "Order/Lost date" }, "todo2": { "type": "integer", "title": "Next to-do" } } }, "To-do": { "type": "object", "required": [ "starttime" ], "properties": { "id": { "type": "integer", "readOnly": true }, "subject": { "type": "string", "title": "Subject" }, "coworker": { "type": "integer", "title": "Coworker" }, "starttime": { "type": "string", "format": "date-time", "title": "Start time" }, "endtime": { "type": "string", "format": "date-time", "title": "End time" }, "person": { "type": "integer", "title": "Person" }, "location": { "type": "string", "title": "Location" }, "calendarstatus": { "type": "object", "title": "Calendar status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "active", "changed", "deleted" ] }, "text": { "type": "string" } } }, "calendarid": { "type": "string", "title": "Calendar ID" }, "done": { "type": "boolean", "title": "Done" }, "helpdesk": { "type": "integer", "title": "helpdesk" }, "todostatus": { "type": "object", "title": "To-do status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "active", "delayed", "done", "future" ] }, "text": { "type": "string" } } }, "note": { "type": "string", "title": "Notes" }, "company": { "type": "integer", "title": "Company" }, "deal": { "type": "integer", "title": "Deal" }, "campaign": { "type": "integer", "title": "Marketing activity" }, "solutionimprovement": { "type": "integer", "title": "Solution improvement" } } }, "History": { "type": "object", "required": [ "date", "note", "type" ], "properties": { "id": { "type": "integer", "readOnly": true }, "date": { "type": "string", "format": "date-time", "title": "Date" }, "type": { "type": "object", "title": "Type", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "talkedto", "customervisit", "salescall", "noanswer", "comment", "sentemail", "receivedemail", "checklist", "autocomment" ] }, "text": { "type": "string" } } }, "company": { "type": "integer", "title": "Company" }, "person": { "type": "integer", "title": "Person" }, "coworker": { "type": "integer", "title": "Coworker" }, "deal": { "type": "integer", "title": "Deal" }, "campaign": { "type": "integer", "title": "Marketing activity" }, "helpdesk": { "type": "integer", "title": "helpdesk" }, "document": { "type": "integer", "title": "Document" }, "checklist_item": { "type": "string", "title": "Checklist" }, "note": { "type": "string", "title": "Notes" }, "solutionimprovement": { "type": "integer", "title": "Solution improvement" } } }, "Document": { "type": "object", "required": [ "type" ], "properties": { "id": { "type": "integer", "readOnly": true }, "comment": { "type": "string", "title": "Description" }, "type": { "type": "object", "title": "Document type", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "agreement", "email", "tender", "other", "picture", "document" ] }, "text": { "type": "string" } } }, "company": { "type": "integer", "title": "Company" }, "person": { "type": "integer", "title": "Person" }, "document": { "type": "string", "title": "Document" }, "coworker": { "type": "integer", "title": "Coworker" }, "deal": { "type": "integer", "title": "Deal" }, "helpdesk": { "type": "integer", "title": "helpdesk" }, "campaign": { "type": "integer", "title": "Marketing activity" }, "solutionimprovement": { "type": "integer", "title": "Solution improvement" } } }, "Marketing_activity": { "type": "object", "required": [ "budget", "name", "outcome" ], "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Name" }, "campaignstatus": { "type": "object", "title": "Campaign status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "planned", "enum": [ "planned", "empty", "ongoing", "finished", "cancelled" ] }, "text": { "type": "string" } } }, "coworker": { "type": "integer", "title": "Responsible" }, "type": { "type": "object", "title": "Type", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "ad", "dm", "customeractivity", "fair", "seminar", "sendout", "empty", "email" ] }, "text": { "type": "string" } } }, "location": { "type": "string", "title": "Location" }, "startdate": { "type": "string", "format": "date-time", "title": "Start date" }, "enddate": { "type": "string", "format": "date-time", "title": "End date" }, "budget": { "type": "string", "title": "Budget" }, "outcome": { "type": "string", "title": "Outcome" }, "purpose": { "type": "string", "title": "Purpose" }, "goal": { "type": "string", "title": "Goal" }, "workmode": { "type": "string", "title": "Approach" } } }, "Participant": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "person": { "type": "integer", "title": "Participant" }, "participantstatus": { "type": "object", "title": "Participant status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "accept", "decline", "participated", "invitation", "recipient" ] }, "text": { "type": "string" } } }, "campaign": { "type": "integer", "title": "Marketing activity" }, "misc": { "type": "string", "title": "Notes" } } }, "Office": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Name" }, "phone": { "type": "string", "title": "Phone" }, "fax": { "type": "string", "title": "Fax" }, "www": { "type": "string", "title": "Homepage" }, "businessunit": { "type": "integer", "title": "businessunit" }, "registrationno": { "type": "string", "title": "Registration number" }, "vatno": { "type": "string", "title": "VAT registration number" }, "pg": { "type": "string", "title": "Post giro" }, "bg": { "type": "string", "title": "Bank giro" }, "address": { "type": "string", "title": "Address" }, "visitingaddress1": { "type": "string", "title": "Visiting address " }, "zipcode": { "type": "string", "title": "Zip code" }, "city": { "type": "string", "title": "City" }, "visitingzipcode": { "type": "string", "title": "Visiting zip code" }, "visitingcity": { "type": "string", "title": "Visiting city" }, "misc": { "type": "string", "title": "Other information" } } }, "InfoTile": { "type": "object", "required": [ "classname", "color" ], "properties": { "id": { "type": "integer", "readOnly": true }, "active": { "type": "boolean", "title": "Active" }, "visiblefor": { "type": "object", "title": "Visible for", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "All", "enum": [ "All", "department", "me" ] }, "text": { "type": "string" } } }, "coworker": { "type": "integer", "title": "Specific coworker" }, "operator": { "type": "object", "title": "Operator", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "count", "enum": [ "count", "link", "sum", "field" ] }, "text": { "type": "string" } } }, "visibleon": { "type": "string", "title": "Visible on" }, "classname": { "type": "string", "title": "Tab" }, "fieldname": { "type": "string", "title": "Field" }, "filtername": { "type": "string", "title": "Filter" }, "icon": { "type": "string", "title": "Icon" }, "label": { "type": "string", "title": "Label in actionpad" }, "sortorder": { "type": "string", "title": "Sort order" }, "size": { "type": "object", "title": "Size", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "small", "enum": [ "small", "medium", "large" ] }, "text": { "type": "string" } } }, "color": { "type": "object", "title": "Color", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "empty", "clean-green", "blue", "purple", "yellow", "green", "citrus", "deep-red", "light-grey", "magenta", "dark-grey", "purple-rain", "orange", "red", "turquoise" ] }, "text": { "type": "string" } } }, "visibleonzero": { "type": "boolean", "title": "Visible on Zero" } } }, "Solution_improvement": { "type": "object", "required": [ "title" ], "properties": { "id": { "type": "integer", "readOnly": true }, "created": { "type": "string", "format": "date-time", "title": "Created" }, "coworkercreatedby": { "type": "integer", "title": "Created by" }, "card": { "type": "string", "title": "Card" }, "priority": { "type": "object", "title": "Priority", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "wish", "enum": [ "wish", "better", "urgent", "testcase" ] }, "text": { "type": "string" } } }, "title": { "type": "string", "title": "Title" }, "misc": { "type": "string", "title": "Detailed description" }, "solutionimprovementstatus": { "type": "object", "title": "Status", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "reported", "enum": [ "reported", "started", "infoneeded", "done", "deny", "approved" ] }, "text": { "type": "string" } } }, "coworker": { "type": "integer", "title": "Responsible" }, "latestupdate": { "type": "string", "format": "date-time", "title": "Last update" }, "donedate": { "type": "string", "format": "date", "title": "Rejection/Done date" }, "comment": { "type": "string", "title": "Comment/Solution/Decision" } } }, "Localization": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "owner": { "type": "string", "title": "Owner" }, "code": { "type": "string", "title": "Text code" }, "lookupcode": { "type": "string", "title": "VBA Lookup code" }, "formtag": { "type": "string", "title": "VBA Form tag" }, "aplocalizecode": { "type": "string", "title": "Actionpad translation code" }, "context": { "type": "string", "title": "Context" }, "sv": { "type": "string", "title": "Swedish" }, "en_us": { "type": "string", "title": "English" }, "false": { "type": "string", "title": "Norwegian" }, "da": { "type": "string", "title": "Danish" }, "fi": { "type": "string", "title": "Finnish" }, "nl": { "type": "string", "title": "Dutch" }, "de": { "type": "string", "title": "German" } } }, "Invoice": { "type": "object", "required": [ "invoice_balance", "invoice_sum", "invoice_total_sum", "invoice_vat" ], "properties": { "id": { "type": "integer", "readOnly": true }, "invoice_number": { "type": "string", "title": "Invoice Number" }, "company": { "type": "integer", "title": "Company" }, "customerid": { "type": "string", "title": "Customer Number" }, "customer_reference": { "type": "string", "title": "Customers Reference" }, "coworker": { "type": "integer", "title": "Our reference" }, "invoice_type": { "type": "string", "title": "Type" }, "invoice_date": { "type": "string", "format": "date", "title": "Invoice Date" }, "invoice_expires": { "type": "string", "format": "date", "title": "Due Date" }, "currency": { "type": "string", "title": "Currency" }, "conversionrate": { "type": "string", "title": "Conversion rate" }, "invoice_sum": { "type": "string", "title": "Amount" }, "invoice_vat": { "type": "string", "title": "VAT" }, "invoice_total_sum": { "type": "string", "title": "Total Amount" }, "invoice_balance": { "type": "string", "title": "Balance" }, "paid": { "type": "boolean", "title": "Paid" }, "paid_date": { "type": "string", "format": "date", "title": "Payment Date" }, "invoice_shredded": { "type": "boolean", "title": "Shredded" } } }, "Invoice_Row": { "type": "object", "required": [ "row_margin", "row_value", "units" ], "properties": { "id": { "type": "integer", "readOnly": true }, "company": { "type": "integer", "title": "Company" }, "invoice": { "type": "integer", "title": "Invoice" }, "item": { "type": "string", "title": "Item" }, "description": { "type": "string", "title": "Description" }, "units": { "type": "string", "title": "Units" }, "row_margin": { "type": "string", "title": "Contribution margin" }, "row_value": { "type": "string", "title": "Amount" }, "rowid": { "type": "string", "title": "Row ID" } } }, "Coworker": { "type": "object", "required": [ "firstname" ], "properties": { "id": { "type": "integer", "readOnly": true }, "picture": { "type": "string", "title": "Picture" }, "firstname": { "type": "string", "title": "First name" }, "lastname": { "type": "string", "title": "Last name" }, "name": { "type": "string", "title": "Name" }, "phone": { "type": "string", "title": "Direct phone" }, "mobilephone": { "type": "string", "title": "Mobile phone" }, "email": { "type": "string", "title": "Email" }, "office": { "type": "integer", "title": "Office" }, "department": { "type": "object", "title": "Department", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "308501", "enum": [ "308501", "sales", "marketing", "finance", "administration" ] }, "text": { "type": "string" } } }, "username": { "type": "string", "title": "User name" }, "admin": { "type": "boolean", "title": "Administrator" }, "inactive": { "type": "boolean", "title": "Inactive" }, "lastlogintime": { "type": "string", "format": "date-time", "title": "Last login time" } } }, "businessunit": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Name" } } }, "helpdeskcategory": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "name" }, "businessunit": { "type": "integer", "title": "businessunit" }, "inactive": { "type": "boolean", "title": "inactive" } } }, "Helpdesk_type": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Name" }, "inactive": { "type": "boolean", "title": "Inactive" }, "office": { "type": "integer", "title": "office" }, "helpdeskcategory": { "type": "integer", "title": "helpdeskcategory" } } }, "Legal_base_&_consent": { "type": "object", "required": [ "date", "source" ], "properties": { "id": { "type": "integer", "readOnly": true }, "consenttype": { "type": "integer", "title": "Legal base & consent type" }, "approved": { "type": "boolean", "title": "Approved" }, "date": { "type": "string", "format": "date-time", "title": "Date" }, "source": { "type": "object", "title": "Source", "properties": { "id": { "type": "integer" }, "key": { "type": "string", "default": "empty", "enum": [ "381301", "empty", "coworker", "email", "portal", "letter", "newsletter", "webform" ] }, "text": { "type": "string" } } }, "note": { "type": "string", "title": "Note" }, "person": { "type": "integer", "title": "Person" }, "company": { "type": "integer", "title": "Company" } } }, "Checklist": { "type": "object", "required": [ "item_template_id", "order", "owner_table" ], "properties": { "id": { "type": "integer", "readOnly": true }, "order": { "type": "integer", "title": "Order" }, "title": { "type": "string", "title": "Title" }, "item_template_id": { "type": "string", "title": "item_template_id" }, "group_item_template_id": { "type": "string", "title": "group_item_template_id" }, "is_group": { "type": "boolean", "title": "Group" }, "multi_option_parent": { "type": "boolean", "title": "Multio Option Parent" }, "multi_option_child": { "type": "boolean", "title": "Multi Option" }, "done": { "type": "boolean", "title": "Done" }, "ignore": { "type": "boolean", "title": "Ignored" }, "coworker": { "type": "integer", "title": "Coworker" }, "done_date": { "type": "string", "format": "date-time", "title": "Done (Date)" }, "ignore_date": { "type": "string", "format": "date-time", "title": "Ignored (Date)" }, "deadline": { "type": "string", "format": "date-time", "title": "Deadline" }, "checklist_item_previous": { "type": "integer", "title": "Previous Item" }, "history": { "type": "integer", "title": "History" }, "selected_option_title": { "type": "string", "title": "Selected Option" }, "owner_table": { "type": "string", "title": "owner_table" }, "helpdesk": { "type": "integer", "title": "helpdesk" } } }, "Consent_type": { "type": "object", "required": [ "title" ], "properties": { "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "title": "Title" }, "active": { "type": "boolean", "title": "Active" }, "readonly": { "type": "boolean", "title": "Readonly" }, "default": { "type": "boolean", "title": "Default when new" }, "description": { "type": "string", "title": "Description" } } }, "Error": { "type": "object", "properties": { "limeobject_id": { "type": "integer" }, "limetype": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorDetail" } } } }, "ErrorDetail": { "type": "object", "properties": { "error_message": { "type": "string" }, "limeproperty": { "type": "string" }, "error_code": { "type": "string" } } } }, "x-wso2-cors": { "corsConfigurationEnabled": false, "accessControlAllowOrigins": [ "*" ], "accessControlAllowCredentials": false, "accessControlAllowHeaders": [ "authorization", "Access-Control-Allow-Origin", "Content-Type", "SOAPAction", "apikey", "testKey" ], "accessControlAllowMethods": [ "GET", "PUT", "POST", "DELETE", "PATCH", "OPTIONS" ] }, "x-wso2-production-endpoints": { "urls": [ "https://saas226.stadsbacken.se/lime_see_prod/api/v1/limeobject" ], "type": "http" }, "x-wso2-sandbox-endpoints": { "urls": [ "https://saas226.stadsbacken.se/lime_see_prod/api/v1/limeobject" ], "type": "http" }, "x-wso2-basePath": "/limeobject/1.0.0", "x-wso2-transports": [ "https" ], "x-wso2-application-security": { "security-types": [ "oauth2" ], "optional": false }, "x-wso2-response-cache": { "enabled": false, "cacheTimeoutInSeconds": 300 } } |
Säkerhetsklassning
Säkerhetsklass 2
Autentiseringsmetod: Oauth2 + api-nyckel
Teknisk ägare
Andreas Uhrner
Källkod
N/A
FAQ
N/A