![](\"https://res.cloudinary.com/www-yoobic-com/image/upload/v1554025223/export_excel_example.png\")
\n\n##### Export File Expiration\n\nCurrently all exports are set to expire **one day** after they are created at which point they will be inaccessible.\n\n#### Import File\n\n\n\n\nImport a CSV/Excel file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job.\nMake sure that you make a multipart/form-data query, passing the CSV/Excel file as named parameter `file`.\nWhen you create a CSV/Excel file to import, you'll probably generate this list from some other information management system or database. Most of these systems have some facility for creating a CSV/Excel export file. If you need to create the list from scratch you can use a program like Microsoft Excel or OpenOffice.org Calc.\n\n**Important**:\n\n- To ensure correct handling of special characters, you must generate the CSV/Excel file using the UTF-8 character encoding.\n\n- The first row of the file is the header row, and you must include it in the file.\n\n- The header row must contain any required fields in the table below, plus any other fields listed in the table below that you want to include.\n\n- Empty columns of data in the file will overwrite any existing data for that entity (empty column is treated as a *null* value).\n\n- For Excel files, array type fields (i.e.: `tags` for users or stores, `client_ids` for users…) must be comma separated string i.e.: Tag1,Tag2,Tag3 or Tag1, Tag2, Tag3\n\n- For CSV files, array type fields can be either comma separated strings (i.e.: Tag1,Tag2,Tag3 or Tag1, Tag2, Tag3) or JSON array with quotes (i.e.: `\"[\"Tag1\",\"Tag2\",\"Tag3\"]\"`)- In Addition for CSV the field separator is `;` and line separator is `line-break`.\n\n- Make sure there are no duplicates by the defined primary keys as there is no guarantee on the order in which the import iterates over the rows.\n\n- Date values should comply with the ISO format, i.e. 2019-12-31 or 2019-12-31T23:59:59:999.\n\n- Escape special characters in CSV files with double quotes, for example: `\"Link\"`."
},
"servers": [
{
"url": "https://![](\"https://user-images.githubusercontent.com/31584145/46032347-06a05180-c104-11e8-87f3-1bddb628a90c.png\")
\n\n- With the exception of Stores, geographic filters should always be dynamic. This is because it is easier to add a store to a type so that it inherits its geographic filter than it is to add a store to each geographic filter it needs to be in.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`geofilter_id` | string | x | x | | Unique geofilter id |\n|`user_id` | string | x | | x | Unique user id |\n|`store_ids` | array | | | x | Unique store ids |\n|`store_client_ids` | array | | | | External unique ids of the stores as it may exists in your Information System|\n|`store_type_names` | array | | | | The names of the store types |\n|`store_type_ids` | array | | | x | The ids of the store types |\n|`created_date` | date | | x | | Created Date |\n|`updated_date` | date | | x | x | Updated Date |\n\nOne of either fields is required in order to resolve the mapping between a user and store/s:\n\n- store_ids\n\n- store_client_ids\n\n- store_type_ids\n\n- store_type_names"
},
{
"name": "Groups",
"description": "\nGroups are used to manage users. This is VERY important as Groups are what make using the application much simpler. By adding Users to Groups, when you need to modify sets of Users, you just change the groups properties and all the Users in the Group inherit these properties (much better than changing each individual user manually). Moreover, Groups allow to restrict visibility when some entities are shared (Missions, News, Documents, ...)\n\n### How do I structure my groups ?\n\nEach Group usually corresponds to a population of Users (ex: Admin, HQ, VM Managers, Retail Area Managers, Stores, etc.).\n![](\"https://user-images.githubusercontent.com/4806944/41535702-fd95441a-730b-11e8-8fbe-603f8a43f51f.png\")
\n\n### General Group\n\nUsually there is a general group, which has the name of the tenant.\nThis group will contain all of the other Groups and will give the Users access to shared information.\n\nThen you will usually find a Group for each type of user. \nThese usually fall into one of these categories:\n\n* Admin\n\n* Area Managers\n\n* HQ\n\n* Itinerants\n\n* Store Users\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|-----------------------------|:--------:|:--------:|:--------:|:-------:| -------------------------|\n|`group_id` | string | | x | | The group_id corresponds to the Group title in lowercase letters, with `_` instead of spaces, and without special characters |\n|`title` | string | x | | | Group Title |\n|`description` | string | | | | Group Description |\n|`group_ids` | array | | | x | group ids that belong to this group |\n|`user_ids` | array | | | x | user ids that belong to this group |\n|`created_date` | date | | x | | Created Date |\n|`updated_date` | date | | x | x | Updated Date |\n|`icon_url` | string | | | | Icon URL |\n\n### Tip\n\nTo summarise, remember that:\n\n* Users are organised in groups\n\n* Groups must be created prior to importing any users to the database\n\n* A user can belong to multiple groups\n\n* There can be sub-groups\n\n* Users inherit their level or rights from the group(s) they belong to\n![](\"https://user-images.githubusercontent.com/4806944/41536506-7949d9d4-730e-11e8-81d8-62c0bc39c9e3.png\")
"
},
{
"name": "Incentives Kpi",
"description": "\nIncentives-KPIs are an indicator for users’ progress within an incentive. Each incentives-kpi represents the sale of one or more items of a single product. When a user submits new progress for an incentive, the data is then broken down product by product, creating one or several new kpis. In case there are no products involved, submitting new progress will generate a single incentive kpi with an empty product\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|------------------------------------------------|\n|`incentive_kpi_id` | string | | x | | Unique id incentive_kpi |\n|`incentive_id` | string | x | | | The incentive_id |\n|`owner_id` | string | x | | | The user who submitted the kpi |\n|`username` | string | | x | | The owner username |\n|`first_name` | string | | x | | The owner first name |\n|`last_name` | string | | x | | The owner last name |\n|`participant_type` | string | x | | | Type of incentives-kpi ('individual' or 'team')|\n|`start_time` | date | x | | | The start time of the kpi |\n|`end_time` | date | x | | | The end time of the kpi |\n|`participant_user_id` | string | | | | The participant user in kpi |\n|`participant_group_id`| string | | | | The participant group in kpi |\n|`product_id` | string | | | | product_id involved in the kpi |\n|`price` | number | | x | | The product's price |\n|`count` | number | | | | Number of units in the kpi |\n|`weight` | number | | x | | Weight of product in total calculation |\n|`total` | number | | | | Total value of the kpi |\n|`created_date` | date | | x | | KPI submission date |\n|`updated_date` | date | | x | x | Last update date |\n\nOnly one of these fields is required:\n\n- participant_user_id\n\n- participant_group_id\n\n**Important:**\n\n- If `participant_type` equals `teams`, `participant_group_id` must be filled with `group_id` value.\n\n- If `participant_type` equals `individual`, `participant_user_id` must be filled with `user_id` value.\n\n- `product_id` is optional and appear only if product is part of the related incentive.\n\n- `price` has a value only if a `product_id` exists."
},
{
"name": "Inventory",
"description": "\nAn Inventory is a custom data structure to manage and use data in a similar way as in a spreadsheet or database directly from the YOOBIC Platform. Each inventory has a defined structure that rely on the same fields as in a YOOBIC campaign.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`inventory_id` | string | x | x | | Unique id of the inventory |\n|`description` | string | | x | | The inventory description |\n|`name` | string | | x | | The inventory name |\n|`title` | string | | x | | The inventory title |\n|`group_ids` | array | | x | | Group ids that can see this inventory |\n|`page_titles` | array | | x | | An ordered list of page titles i.e. first title is the first page title etc. |\n|`questions` | array | | x | | The inventory's questions |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |\n\nThe `questions` field is defined as an array of:\n| Field | Type | Description |\n|----------------------|----------------|---------------------------|\n|`question_id` | string | Unique id of the question |\n|`question_type` | string | The type of the question. Supported types: `text`, `textarea`, `toggle`, `checkbox`, `information`, `todo`, `photo`, `multiphotos`, `selectbuttons`, `select`, `selectmulti`, `address`, `date`, `number`, `starrating`, `image`. |\n|`question` | string | The title of the question |\n|`question_description`| string | The description of the question |\n|`mandatory` | boolean | If `true`, the question has to be answered. Defaults to `false` |\n|`page_number` | number | The number of the page the question appears in |\n|`question_number` | number | The number of the question |\n|`hide_mobile` | boolean | Hide the question on mobile devices. Defaults to `false`. |\n|`question_attributes` | object | Question attributes for specific question types.|\n\nThe `question_attributes` field is defined as an object with the following fields:\n| Field | Type | Description |\n|----------------------|----------------|---------------------------|\n|`max_photos` | number | Maximum of allowed photos to upload. Applies only to questions of type `multiphotos`. |\n|`values` | array | Values to be displayed as options to choose from in the question. Applies only to questions of type `selectbuttons`, `select`, `selectmulti`. |\n|`min` | number | If present, value must be above or including it. Applies only to questions of type `number`. |\n|`max` | number | If present, value must be below or including it. Applies only to questions of type `number`, `starrating`. |\n\n#### Question Types\n\n\n**Important** \nBelow is a list of the supported types and their value types:\n\n| question_type | Type | Description |\n|---------------|:--------------:|-------------|\n| address | string | |\n| date | string | |\n| information | string | |\n| select | string | Single value chosen from the `values` defined in `question_attributes` |\n| textarea | string | |\n| text | string | |\n| photo | URL | A valid image URL |\n| multiphotos | array of URLs | Valid image URLs and up to `max_photos` defined in `question_attributes` |\n| selectbuttons | array | Multiple values chosen from the `values` defined in `question_attributes` |\n| selectmulti | array | Multiple values chosen from the `values` defined in `question_attributes` |\n| number | number | Might have min, max borders as defined in `question_attributes` |\n| starrating | number | Might have max border as defined in `question_attributes`. No negatives allowed. |\n| checkbox | boolean | |\n| toggle | boolean | |\n| image | | This is a readonly property (informative) which does not have a value. |\n\n**Important**\n\n- If `page_titles` does not have a title for a given page then a default will be given - \nSo i.e. if the values are - \n```json\n[ \"first chapter\", \"second chapter\" ]\n``` \nand there are three pages in total, then the title for the third page will be `Page 3`.\n\n- To filter on `live` campaigns only you should filter accordingly: \n```json\n{ \"active\": true, \"archived\": { \"neq\": true } }\n```"
},
{
"name": "Lessons",
"description": "\nLessons are the activities the users perform during their trainings.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`lesson_id` | string | x | x | | Unique id of the lesson |\n|`title` | string | | x | | Title of the lesson |\n|`type` | string | | x | | Type of lesson (currently just lesson) |\n|`campaign_id` | string | | x | x | Unique id of the campaign |\n|`plan_id` | string | | x | | Unique id of the plan |\n|`course_id` | string | | x | | Unique id of the course |\n|`user_id` | string | | x | | Unique id of the user |\n|`status` | string | | x | x | Whether the lesson is finished or not |\n|`points` | number | | x | | Number of points of the lesson |\n|`score` | object | | x | | Score of the user |\n|`duration` | number | | x | | Time spent on the lesson (in minutes) |\n|`validated` | boolean | | x | | Whether the lesson is successfull or a failure |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |\n\nThe `answers` field is defined as an array of:\n| Field | Type | Required | Readonly | Description |\n|----------------------|:--------------:|:---------:|:---------:|---------------------------|\n|`question_id` | string | | x | Unique id of the question |\n|`question_type` | string | | x | The type of the question |\n|`question` | string | | x | The title of the question |\n|`page_number` | number | | x | The number of the page the question appears in |\n|`question_number` | number | | x | The number of the question on the page |\n|`answer` | string | | x | The value of the answer |"
},
{
"name": "Missions",
"description": "\nMissions are the basic campaign type. The store users will receive missions with fields to complete, for example send a photo of their display or change the location of the new collection in store. The mission creator will define its content from the dashboard, then he will publish it to the appropriate stores. Once the users have completed the mission they will be able to submit it. The managers responsible for the store will then be able to define the mission as compliant (if they deem the answers acceptable) or non compliant (if they believe there is room for improvement). If a mission is evaluated as non compliant, the manager can choose for the user to retake the mission entirely or he can specify which parts of the mission need improving and republish the mission to the store with the rest of the answers already filled in.\n\nTips: a mission is an entity of a campaign published on a store.\n\n![](\"https://user-images.githubusercontent.com/4806944/46027402-7576ae00-c0f6-11e8-9579-808251a4aa97.png\")
\n\nA mission is either available, ongoing or finished.\n![](\"https://user-images.githubusercontent.com/4806944/46028408-2e3dec80-c0f9-11e8-92c4-673fc5ef4794.png\")
\n\nA finished mission is either \"to validate\", \"compliant\" or \"not compliant\".\n\n- **Available** : a mission is available as soon as it has been published on a store, and hasn't been started yet by a user.\n\n- **Ongoing**: as soon as a user starts or loads a mission, the status of the mission goes from \"available\" to \"ongoing\" (known as `booked` under the status field of a mission)\n\n- **Finished** : once the mission has been submitted, it is finished.\n - **To validate**: if the mission hasn't been validated yet and marked as \"compliant\" or \"not compliant\", or isn't configured to be automatically marked as compliant.\n - **Compliant** \n - **Not compliant**\n\n- **Scheduled**: a mission is scheduled as soon as it has been published on a store and if `valid_from` date did not reach the current date yet.\n\n- **Archived**: a mission gets status archived as soon as it’s archived\n\n### Fields\n\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|--------------------------------|--------------|:--------:|:--------:|:-------:|-----------------|\n|`mission_id` | string | x | x | | Unique id of the mission |\n|`title` | string | | | | The title of the mission |\n|`type` | string | | | x | Mission type |\n|`campaign_id` | string | | x | x | Unique id of the mission's parent campaign |\n|`user_id` | string | | x | x | Unique id of the user who performs the mission |\n|`creator_id` | string | | | x | Unique id of the mission creator |\n|`store_id` | string | | x | x | Unique id of associated store |\n|`status` | string | | x | x | Current status of the mission if set: `\"scheduled\"`, `\"booked\"`, `\"finished\"`, `\"archived\"` |\n|`valid_from` | timestamp | | x | | Mission available from |\n|`republish_count` | number | | | | The number of times the mission was republished |\n|`available_on_book` | boolean | | x | | If `true`, a new copy of this mission would be created when the mission is started |\n|`available_on_finished` | boolean | | x | | If `true`, a new copy of this mission would be created on finish |\n|`booked_date` | timestamp | | x | | The date on which the mission was booked to a user |\n|`due_date` | timestamp | | x | | The date by which the mission must be completed |\n|`duration` | number | | x | | Time spent on the mission (in minutes) |\n|`finished_date` | timestamp | | x | x | The date on which the mission was finished |\n|`score` | object | | | | The score of the mission as a JSON object `{\"title\": \"my score\", \"value\": 10}` |\n|`extra_scores` | object | | | | The extra scores of the mission as a JSON object `{\"score1\": { \"title\": \"my score\", \"value\": 10}}` |\n|`compliant` | boolean | | x | | The compliance of the mission as marked by an area manager: `true` if marked compliant, `false` if marked noncompliant. If nothing is specified and if the mission is finished, `status` will be \"to validate\" |\n|`compliant_by_default` | boolean | | | | If `true` the mission is automatically marked compliant on finish |\n|`validated_date` | timestamp | | x | | The date on which the mission was validated |\n|`reason_noncompliant` | string | | | | The reason provided by the area manager to explain why the mission was marked noncompliant |\n|`republished_with_answers` | boolean | | x | | Has the mission been repulished with the previous answers after being marked noncompliant |\n|`original_mission_id` | string | | x | | If present, the `mission_id` of the mission that this mission was republished from |\n|`original_reason_noncompliant` | string | | x | | The `reason_noncompliant` from the original mission that was republished. |\n|`updated_date` | timestamp | | x | x | Mission's last update date |\n|`created_date` | timestamp | | x | | Mission's creation date |\n|`answers` | array | | | | Mission's questions and answers, if misssion is finished (see below) |\n|`group_ids` | array | | | | Group ids that can see this mission |\n|`user_ids` | array | | | | User ids that can see this mission |\n|`action_plan_progress` | number | | x | | Completion rate of an action plan. |\n|`task_number` | number | | x | | Auto generated when a new mission is created. The value is unique within a campaign |\n\n**Important**: \nPlease note that to retrieve the value of the answers for a specific mission, you will need to use the single mission endpoint.\n\nThe `answers` field is defined as an array of:\n| Field | Type | Description |\n|----------------------|----------------|---------------------------|\n|`question_id` | string | Unique id of the question |\n|`question_type` | string | The type of the question |\n|`question` | string | The title of the question |\n|`page_number` | number | The number of the page the question appears in |\n|`question_number` | number | The number of the question on the page |\n|`answer` | string | The value of the answer |"
},
{
"name": "Mission Comments",
"description": "\nPerform operations on comments linked to missions.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|--------------------------- |\n|`comment_id` | string | | x | | Unique id of the comment |\n| user_id | string | x | | | Id of the user who created the comment |\n| mission_id | string | x | | | Id of the mission that was interacted with this comment |\n|`text` | string | x | | | Comment text |\n|`photo_url` | string | x | | | Comment photo |\n|`comment_date` | date | | | | The date of the comment |\n|`updated_date` | date | | | x | Last update date |\n|`created_date` | date | | | | Creation date |\n\n**Important**:\n\n- Either `text` or `photo_url` are required\n\n- The message can be only a single text or a single photo url. The photo url to be visible in YOOBIC should be a valid url to an image (jpg, png, gif, etc...).\n\n- The mission comment does not support sub comments or reply to comments or reaction to comments. It is a simple comment with no reference to the original comment.\n\n- To handle historical comment you should use the `comment_date` field. In case the `comment_date` is not provided, the `updated_date` will be used instead.\n\n- The text of the comment is limited to 2000 characters."
},
{
"name": "News",
"description": "\nContains information coming from the news feed tab\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`news_id` | string | | x | | Unique id of the news |\n|`user_id` | string | x | | x | Unique id of a user who published the news |\n|`title` | string | | | | The title of news |\n|`description` | string | x | | | The html content of the news feed |\n|`group_ids` | array | x | | | Group ids that can see this news |\n|`user_ids` | array | | | | User ids that can see this news |\n|`views` | number | | x | | News item views count |\n|`likes` | number | | x | | News item likes count |\n|`authorised_viewers` | number | | x | | Number of users allowed to view this news feed |\n|`images` | array | | | | Images to illustrate the news. Max 20 images per news |\n|`tags` | array | | | | News' list of tags |\n|`created_date` | date | | x | | News item creation date |\n|`updated_date` | date | | x | x | News item last update date|"
},
{
"name": "Notifications",
"description": "\nNotifications provide information about the internal notifications sent to users in the application.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`notification_id` | string | x | x | | Unique id of the notification |\n|`title` | string | x | | | The title of notification |\n|`mode` | string | | | | The way in which the notification is sent. Possible values (`push`, `email`, `all`) |\n|`body` | string | x | | | Notification body |\n|`user_ids` | array | x | | | Target user ids to send the notification |\n|`group_ids` | array | | | | Send notification to all users in group_ids, but not to users from imbricated groups |\n|`badge_type` | string | | x | | Specifies which badge in the Operations or Boost app should be incremented for recipients of this notification |\n|`sender_id` | string | | x | | Unique id of the user triggering the notification |\n|`push_recipients` | number | | x | | Number of recipients |\n|`entity_type` | string | | | | The entity's type for which the notification was created. Possible values (`missions`, `news`, `campaigns`) |\n|`entity_id` | string | | | | The unique id of the entity |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |\n\n**Important**:\n\n- `entity_type` and `entity_id` are used to redirect the user once he/she click on the notification.\n\n- `group_ids` is used only when creating the notification. Therefore, it won't be provided on the response. Instead, all the recipients.\n\n- There is a limit of 50k notifications. If you need to send more than this, you can split the recipients in separate requests targetting different groups."
},
{
"name": "Photos",
"description": "\ncontains information about uploaded photos and photos taken as part of a mission and its relations to the mission.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`photo_id` | string | x | x | | Unique id of the photo |\n|`mission_id` | string | | x | x | Unique id of the mission |\n|`campaign_id` | string | | x | x | Unique id of the campaign |\n|`store_id` | string | | x | | Unique id of the store |\n|`title` | string | | x | | The photo title |\n|`url` | string | | x | | The url to the image |\n|`markup_url` | string | | x | | The markup url to the image |\n|`question_id` | string | | x | x | Unique id of the question |\n|`phash` | string | | x | x | Perceptual hash (fingerprint) |\n|`tags` | array | | x | | Tags assigned to the photo |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |"
},
{
"name": "Plans",
"description": "\nA plan is the main description of a course that's assigned to users.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`plan_id` | string | x | x | | Unique id of the plan |\n|`title` | string | | x | | The plan title |\n|`description` | string | | x | | Description of the plan |\n|`enable_journey` | boolean | | x | | Journey parameter activated or not |\n|`average_completed_lesson` | number | | x | | Average progression in the course |\n|`user_ids` | array | | | | User ids that are assigned to the plan |\n|`creator_id` | string | | | | |\n|`category_id` | string | | | | |\n|`competency_id` | string | | | | |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |"
},
{
"name": "Products",
"description": "\nProducts represent usually physical products and are organised by [`catalog`](#group-catalogs)\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`product_id` | string | | x | | Unique id of the product |\n|`title` | string | x | | | The product title |\n|`price` | number | | | | The product price |\n|`reference` | string | x | | | The product reference (SKU) |\n|`image` | string | | | | The url to the image |\n|`short_desc` | string | | | | Short description of the product |\n|`description` | string | | | | Description of the product |\n|`catalog_id` | string | x | | x | Unique id of the catalog |\n|`catalog_title` | string | x | | | Title of the catalog |\n|`tags` | array | | | | Tags assigned to the product |\n|`manufacturer` | string | | | | The manufacturer name of the product |\n|`brand` | string | | | | The brand name of the product | \n|`category` | string | | | | The category name of the product | \n|`images` | array | | | | The images associated with this product | \n|`out_of_stock` | boolean | | | | Whether or not product is available | \n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |\n|`custom_fields` | object | | | | Dynamic properties (optional)|\n\nOne of either fields is required:\n\n- catalog_id\n\n- catalog_title\n\n**Important:**\n\n- The `image` property should be a secured public URL (HTTPS).\n\n- For best experience in the app, its recommended that the `image` be a square picture.\n\n- `custom_fields` contains new attributes that can be used to describe more precisely a product. \nCustom fields provide a new way to customize your product data by allowing you to filter and select the relevant data in the application. \nYou can create your own custom fields in the YOOBIC Web Application in order to enrich your product data. \nFor the full list of supported field types see [campaigns](#group-campaigns-question-types)\n\n- `reference` is unique per catalog. If a product is uploaded with a combination of `catalog_id` or `catalog_title` and reference that already exist, then the corresponding product is updated."
},
{
"name": "Questions",
"description": "\nQuestions are a Social Learning feature, allowing users to learn tips / expertise from each other. They can ask questions and others can reply to them. Admins and managers can “verify” some answers to make the response official. Essentially, Questions section acts as a forum where knowledge can be shared across the company.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:-----------:|:--------:|:----------:|:-------:|---------------------------|\n|`question_id` | string | x | x | | Unique id of the question |\n|`title` | string | | x | | Title of the question |\n|`description` | string | | x | | Description of the question |\n|`user_id` | string | | x | | User id creating the question |\n|`is_wiki` | boolean | | x | | Whether or not the question exists in the knowledge base | \n|`is_verified` | boolean | | x | | Whether or not this is a verified question | \n|`likes` | number | | x | | Likes count | \n|`answers` | number | | x | | Answers count | \n|`bookmarks` | number | | x | | Number of users who bookmarked the question | \n|`tags` | array | | x | | List of tags |\n|`image` | string | | x | | The url to the image |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |"
},
{
"name": "Roles",
"description": "\nGet the list of Roles available for the users in your organization. The roles are defined by a combination of `client_role` and `client_role_extension`\n\nThe `client_role` refers to a YOOBIC specific role name between ROLEFIELD, ROLEMANAGER, ROLEEDITOR, ROLESTOREMANAGER, ROLESTORE, ROLEADMIN, and ROLEVIEWER and has an impact on some default features of the platform. It also determines what license level the user is attached to.\n\nThe `client_role_extension` refers to a customer-specific designation of a user role, usually based on the job or responsibility of the teams. It is used to differentiate users with the same license level but access to different modules of the platform.\n\nEach combination of client_role and `client_role_extension` is given a unique acl_role_id at creation\n\nRoles are created during the implementation of the platform and cannot be changed by an administrator either via the public API or from the admin interface.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|------------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`acl_role_id` | string | x | x | | Unique id of the role object |\n|`client_role` | string | x | x | | User roles: ROLEFIELD | ROLEMANAGER | ROLEEDITOR | ROLESTOREMANAGER | ROLESTORE | ROLEADMIN | ROLEVIEWER |\n|`client_role_extension` | string | x | x | | Additional role information |\n|`created_date` | date | | x | | Creation date |\n|`updated_date` | date | | x | x | Last update date |"
},
{
"name": "SCIM",
"description": "\nYOOBIC supports SCIM (System for Cross-domain Identity Management) integrations, enabling seamless user provisioning and management. We offer a dedicated integration with Microsoft Entra ID (formerly Azure AD) to simplify user synchronization and automate identity management. Additionally, we provide a complete Postman collection and detailed documentation to help you effectively use our SCIM endpoint. For more details, please refer to our [Microsoft Entra ID SCIM provisioning guide](https://yoobic.zendesk.com/hc/en-gb/articles/23279718974610-Enable-SCIM-provisioning-with-Microsoft-Entra-ID-Azure) or our [SCIM documentation](https://yoobic.zendesk.com/hc/en-gb/articles/23898081735186-SCIM-Provisioning-overview)."
},
{
"name": "Shifts",
"description": "\nA shift object represents a scheduled period of time in which a specific employee is expected to work at a specific store. The object includes information about the start and end times of the shift, as well as the store location and the ID of the employee who is scheduled to work during that time\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|------------|--------|:--------:|:--------:|:-------:|------------------------------------------------------------------------|\n| username | string | x | | | The unique username of the employee assigned to the shift. |\n| user_id | string | | x | | An external identifier for the employee |\n| title | string | x | | | The title of the shift. (visible in the calendar of the user) |\n| store_id | string | | x | | An external identifier for the employee |\n| start_date | string | x | | x | The start date and time of the shift. |\n| shift_id | string | | x | | The unique identifier of the shift. |\n| end_date | string | x | | x | The end date and time of the shift. |\n| description| string | | | | The description of the shift. |\n| client_id | string | x | | | The unique client_id of the location where the shift takes place. |\n| _lmt | string | | x | | The last modified time of the shift. |\n| _ect | string | | x | | The time when the shift was created. |"
},
{
"name": "Store Types",
"description": " \nStores always belong to specific Store Type. \nStore Types determine which stores users can potentially see. \nThey will be linked to one or several user groups. \nStore types are used to have a better view of where the stores are (regions), or what type they belong to (business unit). \nStores types are handy in the application when publishing campaigns to multiple stores. \n![](\"https://user-images.githubusercontent.com/4806944/41536837-6372e65e-730f-11e8-9bba-78d46a39ca1c.png\")
\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|-----------------------------|:--------:|:--------:|:--------:|:-------:|-----------------------------|\n|`store_type_id` | string | | x | | Unique id of the store type |\n|`name` | string | x | | x | Name of the store type |\n|`group_ids` | array | x | | | Group ids that can see this store type |\n|`user_ids` | array | | | | User ids that can see this store type |\n|`created_date` | date | | x | | Created Date|\n|`updated_date` | date | | x | x | Updated Date|\n\n### Tip\n\nTo summarize remember that stores always belong to specific store type. \nFor example, all stores in the UK might belong to the type \"UK Stores\". \nStore Types must be created before importing or creating stores."
},
{
"name": "Stores",
"description": "\nStores are a very important part of the application. They represent physical locations of stores.\nThey are the entities which receive missions (not the users). The users associated to the stores will be able to see their missions and carry them out if they have the correct roles.\nBefore you can create or import stores, you need to have created the store types. If you don't know how to do that, please refer to the Store Types section which will provide you with a detailed explanation on how to create store types.\n\nIn the front end of the application we now call them sites, to use a wording that also applies to companies in different industries that do not have frontline locations called stores (but perhaps restaurants, pharmacies etc.). But in the context of the API, we still call these entities stores.\n\n![](\"https://user-images.githubusercontent.com/4806944/41537992-bb5dc5fc-7312-11e8-8059-311f076a30c7.png\")
\n\nWhen you use your GPS to get your position on your smartphone, how are you located?\nEvery point on the Earth's surface can be defined with a pair of coordinates: latitude and longitude.\nWhen you are creating new stores, geo location data is required (`latitude` and `longitude`). In these fields you have to enter the coordinates pair of the store you are trying to locate.\n\nIn the case you don't provide them, the coordinates will be infered automatically from the `address` but it may result in a less accurate location than the exact geolocation of the store.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|--------------------------|:-------:|:--------:|:--------:|:-------:|-----------------|\n|`store_id` | string | | x | | Unique store id |\n|`title` | string | x | | | Name of the store|\n|`address` | string | x | | | The full address allows us to locate the store on the map. This is used to display the missions available near the user's position|\n|`tags` | array | | | | Tags allow to specify additional information about the store|\n|`latitude` | float | x | | | Latitude of the store|\n|`longitude` | float | x | | | Longitude of the store|\n|`client_id` | string | x | | x | The external unique id of the store as it may exists in your Information System|\n|`store_type_name` | string | x | | | The name of the store type|\n|`store_type_id` | string | x | | | The id of the store type|\n|`info` | string | | | | Additional information regarding the store. Supports HTML layout |\n|`country` | string | | x | | Country location of the store |\n|`notification_emails` | array | | | | List of email(s) that will be notified when a mission is finished and/or a request is created/finished |\n|`contact_email` | string | | | | Contact's email of the store i.e. store manager's email |\n|`contact_phone` | string | | | | Contact's phone of the store i.e. store manager's phone |\n|`contact_name` | string | | | | Contact's name of the store i.e. store manager's name |\n|`properties` | json | | | | Extra information that enables you to customize the display of the data shown on the Store Activity page. This can be split into 4 components: `columns`, `rows`, `grid`, `html` |\n|`photo` | string | | | | A photo of the store |\n|`vip` | boolean | | | | Indicates if the store is a VIP store (a flagship store) |\n|`timezone` | string | | x | | The Time Zone allows to display the hourly sales data in the store insights in the local time of the store. |\n|`capacity` | number | | | | Maximum number of customers which can be served at the same time |\n|`created_date` | date | | x | | Created Date|\n|`updated_date` | date | | x | x | Updated Date|\n|`custom_fields` | object | | | | Dynamic properties (optional)|\n\nOne of either fields is required:\n\n- address\n\n- geoloc (latitude + longitude)\n\nIn case one of the fields' missing the other one will be inferred automatically by using Google Map API. \nPlease note that the results may be incorrect and it's always recommended to supply both fields. \n`country` field will be resolved using either the geoloc or address. Order of precedence is to resolve by the geoloc and if not present, by address.\n\nOne of either fields is required:\n\n- store_type_name\n\n- store_type_id\n\nThe `properties` field is a json array and can be used to display the following columns, rows, grid, and html.\nIn its most generic format it looks like :\n\n```json\n\n[\n {\n \"title\": \"string\",\n \"type\": \"string\",\n \"headers\": [\n \"string\"\n ],\n \"values\": [\n \"object\"\n ]\n }\n]\n```\n\n#### columns\n\n```\n{\n \"title\" : \"KPI S27\",\n \"type\" : \"columns\",\n \"values\" : [ \n {\n \"title\" : \"Revenues\",\n \"value\" : \"1 456 $\",\n \"isPercent\" : false,\n \"colorHex\" : \"#00FF00\"\n }, \n {\n \"title\" : \"Nb Hours\",\n \"value\" : \"7/66\",\n \"colorHex\" : \"#B404FF\"\n }, \n {\n \"title\" : \"QP\",\n \"value\" : 2.8,\n \"isPercent\" : true,\n \"colorHex\" : \"#B40404\"\n }\n ]\n}\n```\n\n![](\"https://user-images.githubusercontent.com/4806944/67024261-c942a380-f10c-11e9-9a42-07c7415ea421.png\")
\n\n#### rows\n\n```\n{\n \"title\" : \"S26 to S27\",\n \"type\" : \"rows\",\n \"values\" : [ \n {\n \"title\" : \"Revenues\",\n \"value\" : \"14 647 $\",\n \"delta\" : \"+82.5 %\",\n \"colorHex\" : \"#B40404\"\n }, \n {\n \"title\" : \"Clients\",\n \"value\" : \"1 753\",\n \"delta\" : \"-10.3 %\",\n \"colorHex\" : \"#B40404\"\n }, \n {\n \"title\" : \"Basket\",\n \"value\" : \"8.4 $\",\n \"delta\" : \"+4.7 %\",\n \"colorHex\" : \"#04B404\"\n }\n ]\n}\n```\n\n![](\"https://user-images.githubusercontent.com/4806944/67024307-dd86a080-f10c-11e9-82a4-e4e407282fdd.png\")
\n\n#### grid\n\n```\n{\n \"title\" : \"Hours\",\n \"type\" : \"grid\",\n \"headers\" : [ \n \"Day\", \n \"Morning\", \n \"Afternoon\", \n \"Nb Hours\"\n ],\n \"values\" : [ \n {\n \"values\" : [ \n \"Monday\", \n \"9:00\", \n \"20:00\", \n \"5/11\"\n ],\n \"colorHex\" : \"#000000\"\n }, \n {\n \"values\" : [ \n \"Tuesday\", \n \"9:00\", \n \"20:00\", \n \"2/11\"\n ],\n \"colorHex\" : \"#000000\"\n }, \n {\n \"values\" : [ \n \"Wednesday\", \n \"9:00\", \n \"20:00\", \n \"0/11\"\n ],\n \"colorHex\" : \"#000000\"\n }, \n {\n \"values\" : [ \n \"Thursday\", \n \"9:00\", \n \"20:00\", \n \"0/11\"\n ],\n \"colorHex\" : \"#000000\"\n }, \n {\n \"values\" : [ \n \"Friday\", \n \"9:00\", \n \"20:00\", \n \"0/11\"\n ],\n \"colorHex\" : \"#000000\"\n }, \n {\n \"values\" : [ \n \"Saturday\", \n \"9:00\", \n \"20:00\", \n \"0/11\"\n ],\n \"colorHex\" : \"#A0A0A0\"\n }, \n {\n \"values\" : [ \n \"Sunday\", \n \" \", \n \" \", \n \"0/0\"\n ],\n \"colorHex\" : \"#A0A0A0\"\n }\n ]\n}\n```\n\n#### html\n\n```\n{\n \"title\" : \"Reference docs\",\n \"type\" : \"html\",\n \"value\" : \"85%
Share of shelf :
![](\\\"https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/w_50/v1516113345/upyw8n7f9fz3v6zhfq29.png\\\")
Contact us
![](\"https://user-images.githubusercontent.com/31584145/50735233-373c6080-11b4-11e9-832d-ad0ecefb4447.png\")
\n\n**Important:**\n\n`custom_fields` contains new attributes that can be used to describe more precisely a store. \nCustom fields provide a new way to customize your store data by allowing you to filter and select the relevant data in the application. \nYou can create your own custom fields in the YOOBIC Web Application in order to enrich your store data. \nFor the full list of supported field types see [campaigns](#group-campaigns-question-types)"
},
{
"name": "Tenants",
"description": "\nExposes tenant level information.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`tenant_id` | string | x | x | | Unique id of the tenant |\n|`name` | string | | x | | The unique tenant name |\n|`title` | string | | x | | The tenant title |\n|`icon` | string | | x | | The icon of the company |\n|`sql_size` | number | | x | | The company's estimated size |\n|`has_terms_of_acceptance`| boolean | | x | | Does company have acceptance terms |\n|`terms_of_acceptance` | string | | x | | Acceptance terms |\n|`terms_of_acceptance_lmt`| date | | x | | Last date modified acceptance terms |"
},
{
"name": "Translations",
"description": "\nContains translations of common keys used in the app to different languages.\n\n### Table Translations\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`translation_id` | string | x | | | Unique id of the translations |\n|`language` | string | x | | x | Default language chosen for the key |\n|`key` | string | x | | x | The key that references this translation |\n|`value` | string | x | | | Translated key by the default language |\n|`group_ids` | array | x | | | Group ids that can see these translations |\n|`user_ids` | array | | | | User ids that can see these translations |\n|`us` | string | | | | English - United States |\n|`en` | string | | | | English |\n|`ca` | string | | | | English - Canada |\n|`fr` | string | | | | French |\n|`de` | string | | | | German |\n|`es` | string | | | | Spanish |\n|`nl` | string | | | | Dutch |\n|`pl` | string | | | | Polish |\n|`it` | string | | | | Italian |\n|`ru` | string | | | | Russian |\n|`zhs` | string | | | | Simplified Chinese |\n|`zht` | string | | | | Traditional Chinese |\n|`pt` | string | | | | Portuguese |\n|`kr` | string | | | | Kanuri |\n|`ja` | string | | | | Japanese |\n|`ua` | string | | | | Ukrainian |\n|`he` | string | | | | Hebrew |\n|`ar` | string | | | | Arabic |\n|`cz` | string | | | | Czech |\n|`th` | string | | | | Thai |\n|`tr` | string | | | | Turkish |\n|`bg` | string | | | | Bulgarian |\n|`el` | string | | | | Greek |\n|`sl` | string | | | | Slovenian |\n|`sk` | string | | | | Slovak |\n|`ro` | string | | | | Romanian |\n|`hu` | string | | | | Hungarian |\n|`br` | string | | | | Brazilian Portuguese |\n|`et` | string | | | | Estonian |\n|`au` | string | | | | Australian |\n|`ido` | string | | | | Indonesian |\n|`vi` | string | | | | Vietnamese |\n|`da` | string | | | | Danish |\n|`fi` | string | | | | Finnish |\n|`nb` | string | | | | Norwegian |\n|`sv` | string | | | | Swedish |\n|`base_language` | string | | | | the base language code of the plan |\n|`created_date` | date | | | | translations item creation date |\n|`updated_date` | date | | | x | translations item last update date|"
},
{
"name": "Users",
"description": "\nExpose users for your company.\n\nRemember:\n\n- Users are the people at your company with access to the YOOBIC mobile and/or web apps.\n\n- Users can be assigned to one or more groups after they are created\n\n- Users can have multiple tags\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Available for all users | Description |\n|--------------------------|:-------:|:--------:|:--------:|:-------:|:-----------------------:|-----------------|\n|`user_id` | string | | x | | x | Unique user id |\n|`username` | string | x | | x | x | Unique username |\n|`password` | string | x | | | x | Password, required on creation only |\n|`first_name` | string | x | | | x | First name|\n|`last_name` | string | x | | | x | Last name|\n|`client_role` | string | x | | | x | User roles: ROLEFIELD \\| ROLEMANAGER \\| ROLEEDITOR \\| ROLESTOREMANAGER \\| ROLESTORE \\| ROLEADMIN \\| ROLEVIEWER|\n|`client_role_extension` | string | | | | x | Indicates an extension of a user role. Has to match an existing role extension in the database |\n|`email` | string | | | | x | Email |\n|`address` | string | | | | x | User's work address |\n|`groups` | array | x | | | x | The list of groups the user is in|\n|`language` | string | | | | x | Preferred language |\n|`phone` | string | | | | x | Phone number|\n|`photo` | string | | | | x | Url of the user's picture |\n|`store_id` | string | | x | x | x | Primary Store. Setting up a store_id on a user will create a geofilter on this user |\n|`tags` | array | | | | x | Tags allow to specify additional information about the user|\n|`sso` | boolean| x | | | x | Flag if a user will login through a third party |\n|`allow_local_login` | boolean| | | | x | Flag if a user will login with password, even if set to third party in tenant (company) configuration |\n|`last_seen` | date | | x | | x | The date on which the user connected for the last time. |\n|`terms_of_acceptance_date`| date | | x | | x | The date in which terms were last accepted |\n|`mobile_version` | string | | x | | x | Version of the App used on mobile by the user. |\n|`desktop_version` | string | | x | | x | Version of the App used on desktop by the user. |\n|`created_date` | date | | x | | x | Created Date|\n|`updated_date` | date | | x | x | x | Updated Date|\n|`custom_fields` | object | | | | x | Dynamic properties (optional)|\n|`weekly_schedule` | object | | | | x | Contains data on an employee's working hours for each day of the week.|\n|`client_ids` | array | | | | x | List of stores that the user can have access to, selected with their client_id. Creates or updates the corresponding user's geofilter if not empty\n|`store_type_names` | array | | | | x | List of stores' store_types that the user can have access to, selected with their store_type_name. Creates or updates the corresponding user's geofilter if not empty\n| `position` | string | | | | | Position |\n| `department` | string | | | | | Department |\n| `division` | string | | | | | Division |\n| `company` | string | | | | | Company |\n| `hiring_date` | date | | | | | Date when the user joined the company |\n| `skills` | array | | | | | Skills |\n| `cover` | string | | | | | Cover URL |\n| `description` | string | | | | | Description |\n\n**Important:**\n\n- One of either fields is required in case of user creation:\n - password\n - sso\n\n- `allow_local_login` is required only if in tenant (company) configuration it is specified to allow login using a third party, but would like to enable specific user a login with a password instead.\n\n- Combination of `client_role` and `client_role_extension` defines the user's permission. A wrong combination of these two will cause a validation error, specifying an invalid permission. If `client_role_extension` is not passed (optional), `client_role` will refer to the corresponding base permission.\n\n- `custom_fields` contains new attributes that can be used to describe more precisely a user. \nCustom fields provide a new way to customize your user data by allowing you to filter and select the relevant data in the application. \nYou can create your own custom fields in the YOOBIC Web Application in order to enrich your user data. \nFor the full list of supported field types see [campaigns](#group-campaigns-question-types)\n\n- The `username` of a user has to be unique across live and archived users and is used to log in to the platform.\n\n- If a user already has a `store_id` in their profile, the corresponding store’s `client_id` will be exported in the next export. It can be used instead of the `store_id`\n\n- It is possible to add several `client_ids` and/or `store_type_names` for a single user. When updating a user, the list of `client_ids` and `store_type_names` will replace the previous one in the user's geofilter.\n\n- It is not possible to filter users on the `client_ids` or `store_type_names` attributes. Please use the geofilter collection to find if a geofilter exist for a user on a specific store or store_type\n\nDescription of the `weekly_schedule` object:\n\n- This object contains data on an employee's working hours for each day of the week.\n\n- Each day of the week is represented by a key (e.g. `mon`, `tue`, etc.) and has a corresponding value that contains information about the working periods for that day.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|---------|:-------:|:--------:|:--------:|:-------:|-----------------|\n| mon | JSON | no | no | no | Contains data on the working hours for Monday |\n| tue | JSON | no | no | no | Contains data on the working hours for Tuesday |\n| wed | JSON | no | no | no | Contains data on the working hours for Wednesday |\n| thu | JSON | no | no | no | Contains data on the working hours for Thursday |\n| fri | JSON | no | no | no | Contains data on the working hours for Friday |\n| sat | JSON | no | no | no | Contains data on the working hours for Saturday |\n| sun | JSON | no | no | no | Contains data on the working hours for Sunday |\n\nFor each day of the week, the corresponding value is an object with the following fields:\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|---------|--------|----------|----------|---------|------------------------------------------------------------------------|\n| periods | array | no | no | no | Contains an array of objects, each of which represents a working period for the day. |\n\nEach object in the `periods` array has the following fields:\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|-------|--------|----------|----------|---------|------------------------------------------------------------------------|\n| from | string | no | no | no | The start time of the working period. Format is `hh:mm` in UTC. |\n| to | string | no | no | no | The end time of the working period. Format is `hh:mm` in UTC. |\n\nIf a day doesn’t have data in the `weekly_schedule` object, it is considered that the user is not scheduled to work on that day."
},
{
"name": "Visits",
"description": "\nThrough this endpoint the details and/or the approval of the visit could be set. \nBy default, the visits will be shown as pending until they are approved (`compliant`). \nBelow is an example of a typical way of scheduling a visit:\n\n![](\"https://res.cloudinary.com/www-yoobic-com/image/upload/v1568034036/ympswsz9y1j0ziaddexu.png\")
\n\n### Fields\n\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|--------------------------------|--------------|:--------:|:--------:|:-------:|-----------------|\n|`visit_id` | string | | x | | Unique id of the visit |\n|`user_id` | string | x | | x | Unique id of the user who will visit the store |\n|`store_id` | string | x | | x | Unique id of the associated store |\n|`group_ids` | timestamp | x | | | Group ids that can see this visit |\n|`user_ids` | array | | | | User ids that can see this visit|\n|`start_time` | string | | | | The scheduled time of the visit. Format is HH:mm |\n|`end_time` | string | | | | The end time of the visit. Format is HH:mm |\n|`visit_date` | date | x | | | The scheduled date of the visit. Format is YYYY-MM-DD |\n|`compliant` | boolean | | | | The compliance of the visit as marked by an area manager: `true` if marked compliant, `false` if marked noncompliant |\n|`type` | string | | | | Type of the visit chosen among a predefined list |\n|`description` | string | | | | Description of the visit |\n|`creator_id` | string | | x | x | Unique id of the visit creator |\n|`custom_fields` | object | | | | Dynamic properties (optional)|\n|`updated_date` | timestamp | | x | x | Visit's last update date |\n|`created_date` | timestamp | | x | | Visit's creation date |\n\n**Important:**\n\n`custom_fields` contains new attributes that can be used to describe more precisely a user. \nCustom fields provide a new way to customize your user data by allowing you to filter and select the relevant data in the application. \nYou can create your own custom fields in the YOOBIC Web Application in order to enrich your user data. \nFor the full list of supported field types see [campaigns](#group-campaigns-question-types)"
},
{
"name": "Webhooks",
"description": "\nYou can create webhooks with HTTP targets to build integrations with the services or with your back-end system. Examples:\n\n- Alert your team in Slack when a mission is created\n\n- Pass mission to your docs team in Asana after a mission is completed\n\n- Update Salesforce when a new store is created\n\nAn HTTP target lets you pass information to third-party services and REST APIs that accept JSON in HTTP requests.\n\nThe list of topics supporting webhooks are:\n\n- campaigns\n\n- courses\n\n- events\n\n- files\n\n- lessons\n\n- mission-workflows\n\n- missions\n\n- mission-comments\n\n- mission-services\n\n- store-types\n\n- stores\n\n- users\n\n- visits\n\n- webhooks\n\n- For visits, the `delete` action is not supported. To receive deleted visit objects you need to subscribe to the `missions` topic. The deleted visits are sent as their corresponding `mission` object as a visit is a sub-type of missions.\n\n- For mission-comments, only `create` and `update` actions are supported. \nSee example use case [here](https://yoobic.zendesk.com/hc/en-gb/articles/14909941328274-Ticketing-System-Integration-Setup-Guide-Synchronise-Requests-and-Comments-With-External-Tickets#h_01HEJEZ7VEZSGHBCZH7C569T8A).\n\n- For mission-services, only `create` and `update` actions are supported. \nSee example use case [here](https://yoobic.zendesk.com/hc/en-gb/articles/14909941328274-Ticketing-System-Integration-Setup-Guide-Synchronise-Requests-and-Comments-With-External-Tickets#h_01HEJCJBH9B9G62R79FBGKA29N).\n\n- If the webhook has a filter, the webhook will fire only once per object when it matches the filter the first time. For example, if the webhook is on topic `missions` , operations `update` and the filter is `{\"status\": \"finished\"}`, then each mission will trigger a new message only when it is `finished`. If another update happens later, to validate the mission for example, it will not fire a new message.\n\n- To send multiple messages for the same object and operation, set `trigger_on_every_match` to true. For example if you want to track every update for `mission-workflows` for every step of the workflow.\n\n- On mission-workflows, possible to filter on `step_title` and `state`. Both can be used together to **only** fire the webhook when a step is reached. Otherwise, having only a filter on `step_title` results in the webhook firing twice when the step is reached due to the mission being updated when it is assigned to a user.\n\n- The object output of mission-workflows contains the same fields as for a regular mission, with an addition of `workflow_step_title`, `workflow_step_id` and `workflow_state`.\n\n#### Errors\n\nIf a webhook fails it becomes inactive. In addition a failure object with the http status and reason are set on the webhook's object.\n\n```\n {\n \"is_active\": false\",\n \"error\": {\n \"status\": 404,\n \"message\": \"Not Found.\"\n }\n }\n ```\n\nOnce the webhook becomes active again, the error object will be cleared. \ni.e. a PATCH request to fix the broken webhook:\n\n```\n {\n \"is_active\": true,\n \"url\": \"campaign title here updated
", "description": "campaign description here updated", "questions": [ { "question_type": "number", "question": "number of ice-cream flavors", "page_number": 1, "question_number": 1 }, { "question_type": "text", "question": "ice-cream flavors", "page_number": 1, "question_number": 2 }, { "question": "Photo 2", "question_type": "photo", "page_number": 2, "question_number": 1, "question_attributes": { "allow_library": true, "hide_mobile": false, "mandatory": false } } ] } } } } }, "security": [ { "oauth2": [] } ] }, "delete": { "responses": { "204": { "description": "No Content", "headers": {} } }, "summary": "Delete", "operationId": "Delete", "description": "Delete a campaign by id.", "tags": [ "Campaigns" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the campaign", "required": true, "example": "54ab03c6546847ee0d30086a", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/campaigns": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "campaign_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "page_titles": { "type": "array", "items": { "type": "string" } }, "icon_url": { "type": "string" }, "background_url": { "type": "string" }, "questions": { "type": "array", "items": { "type": "object", "properties": { "question_id": { "type": "string" }, "question_type": { "type": "string" }, "question": { "type": "string" }, "question_description": { "type": "string" }, "page_number": { "type": "number" }, "question_number": { "type": "number" }, "mandatory": { "type": "boolean" } } } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "campaign_id": "5dc18578883086880887175e", "title": "campaign title here
", "description": "campaign description here", "type": "mission", "group_ids": [ "staff" ], "page_titles": [ "My first page title" ], "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401814/ji2yhtw926naemtsj6xr.png", "background_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401827/seuuqjbry1e4uusi0nta.png", "questions": [ { "question_id": "32e1e38c-961a-421f-8cb7-ee1eafefbace", "question_type": "text", "question": "Dow do the shelves look today?", "question_description": "Tell us what you see from left to right.
", "page_number": 1, "question_number": 1, "mandatory": false } ], "created_date": "2019-11-05T14:21:44.361Z", "updated_date": "2019-11-05T14:21:44.361Z" } }, "examples": { "response": { "value": { "campaign_id": "5dc18578883086880887175e", "title": "campaign title here
", "description": "campaign description here", "type": "mission", "group_ids": [ "staff" ], "page_titles": [ "My first page title" ], "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401814/ji2yhtw926naemtsj6xr.png", "background_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401827/seuuqjbry1e4uusi0nta.png", "questions": [ { "question_id": "32e1e38c-961a-421f-8cb7-ee1eafefbace", "question_type": "text", "question": "Dow do the shelves look today?", "question_description": "Tell us what you see from left to right.
", "page_number": 1, "question_number": 1, "mandatory": false } ], "created_date": "2019-11-05T14:21:44.361Z", "updated_date": "2019-11-05T14:21:44.361Z" } } } } } } }, "summary": "Create", "operationId": "Create", "description": "Create a campaign.\n\n`icon_url` and `background_url` can be a file's `_downloadURL` or a created photo's `url`. Both have to begin with https://.", "tags": [ "Campaigns" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "icon_url": { "type": "string" }, "background_url": { "type": "string" }, "page_titles": { "type": "array", "items": { "type": "string" } }, "questions": { "type": "array", "items": { "type": "object", "properties": { "question_type": { "type": "string" }, "question": { "type": "string" }, "question_description": { "type": "string" }, "page_number": { "type": "number" }, "question_number": { "type": "number" } } } } }, "example": { "title": "campaign title here
", "description": "campaign description here", "type": "mission", "group_ids": [ "staff" ], "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401814/ji2yhtw926naemtsj6xr.png", "background_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401827/seuuqjbry1e4uusi0nta.png", "page_titles": [ "My first page title" ], "questions": [ { "question_type": "text", "question": "Dow do the shelves look today?", "question_description": "Tell us what you see from left to right.
", "page_number": 1, "question_number": 1 } ] } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/campaigns/{id}/publish": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "mission_ids": { "type": "array", "items": { "type": "string" } } }, "example": { "count": 6, "mission_ids": [ "5bf166a4e44684a31c7a5f86", "5bf166a4e44684a31c7a5f87", "5bf166a4e44684a31c7a5f88", "5bf166a4e44684a31c7a5f89", "5bf166a4e44684a31c7a5f8a", "5bf166a4e44684a31c7a5f8b", "5bf166a4e44684a31c7a5f8c" ] } }, "examples": { "response": { "value": { "count": 6, "mission_ids": [ "5bf166a4e44684a31c7a5f86", "5bf166a4e44684a31c7a5f87", "5bf166a4e44684a31c7a5f88", "5bf166a4e44684a31c7a5f89", "5bf166a4e44684a31c7a5f8a", "5bf166a4e44684a31c7a5f8b", "5bf166a4e44684a31c7a5f8c" ] } } } } } } }, "summary": "Publish", "operationId": "Publish", "description": "Publish missions of a campaign to automatically create one mission per targeted site or per targeted user.\nThe result is the number of newly created missions and the mission ids.\n\n**Important**\nThe mission must be assigned before booking: error message: \"Mission must have an assigned user before it can be booked. Please call the assign endpoint prior to booking the mission.\"\n\n- Only campaigns of type memo, form and workflow are supported (quick tasks not supported)\n\n- Memos cannot be personalised by site (the message is sent as configured in the YOOBIC app)\n\n- If campaign audience is set by site: not possible to specify user_ids for publication\n\n- If campaign audience is set by user: not possible to specify store_ids for publication\n\n- If store_ids specified: missions published to all sites specified OR that match the campaign audience (store_ids that do not match the campaign audience criteria are added)\n\n- If user_ids specified: missions published to all users specified AND that match the campaign audience (user_ids that do not match the campaign audience criteria are ignored)\n\n- If no store_ids specified: missions published to all sites in the audience of the campaign (if the audience is not null)\n\n- If no user_ids specified: missions published to all users in the audience of the campaign (if the audience is not null)\n\n**Example:**\n\nFor a form campaign by site with an audience of 5 sites:\n\n- if no `store_ids`, `store_client_ids`, `store_type_ids` is specified in the request:\n\nRequest - Body:\n\n```\n{}\n```\n\nResponse - Body:\n\n```\n{\n \"count\": 5,\n \"mission_ids\": [\n \"5bf166a4e44684a31c7a5f86\",\n \"5bf166a4e44684a31c7a5f87\",\n \"5bf166a4e44684a31c7a5f88\",\n \"5bf166a4e44684a31c7a5f89\",\n \"5bf166a4e44684a31c7a5f8a\"\n ]\n}\n```\n\n- if `store_ids` is specified in the request:\n\nRequest - Body:\n\n```\n{\n \"store_ids\": [\n \"674843fbf7b5a0004845026b\"\n ]\n}\n```\n\nResponse - Body:\n\n```\n{\n \"count\": 1,\n \"mission_ids\": [\n \"5bf166a4e44684a31c7a5f8c\"\n ]\n}\n```\n\n### Fields\n\n| Field | Format | Required | Description |\n|----------------------|----------|:--------:|-----------------|\n|`store_ids` | array | | Unique store ids|\n|`store_client_ids` | array | | External unique ids of the stores as it may exists in your Information System|\n|`store_type_ids` | array | | The ids of the store types|\n|`user_ids` | array | | Unique user ids |\n|`skip_when_available` | boolean | | Skip publishing for a store if there is already an unbooked mission of the same campaign on that store |\n|`skip_when_exists` | boolean | | Skip publishing for a store if there is already a mission of the same campaign on that store (regardless of status) |\n|`valid_from` | date | | Make a mission visible from the specified date |\n|`valid_until` | date | | Archive an available or ongoing mission after the specified date & time. (Script is run every hour) |\n|`due_date` | date | | Due date in UTC |\n|`priority` | string | | Priority of the published missions. Accepted values: `\"1\"` (high) to `\"4\"` (low). If not specified, the campaign's priority is used. Ignored for memos |\n|`mission_title` | string | | If exists, it replaces the default campaign title. See below for further details |\n|`answers` | array | | Default values for the published missions. Only simple field types are supported — see the list below |\n|`notify` | boolean | | if true will send a notification at publication. More information on who receives the notification in [this](https://yoobic.zendesk.com/hc/en-gb/articles/360015946360-Create-Publish-a-Campaign-Form-Missions-Polls-Requests#01G4Z8A3N45FRJB45DD5B2ZJN0) article. If false or not specified, no notification is sent. |\n\n`mission_title` has two placeholders you can add:\n\n+ `{campaign_title}` if supplied, will be replaced with the original campaign title.\n\n+ `{date_now}` if supplied, today's date will be added to the mission title.\n\nSo i.e. a mission_title could look like - \n``` \"{CAMPAIGN_TITLE} - {DATE_NOW_TEMPLATE} - URGENT\" ``` => ``` \"HQ Store Visit - 01/03/2020 - URGENT\" ```.\n\nThe `answers` field is defined as an array of:\n| Field | Format | Required | Description |\n|----------------------|----------|:--------:|---------------------------|\n|`question_id` | string | x | Unique id of the question |\n|`question_type` | string | | The type of the question |\n|`question` | string | x | The title of the question |\n|`page_number` | number | x | The number of the page the question appears in |\n|`answer` | any | | The value of the answer |\n\nOne of either options is required for the each answer object:\n\n+ question_id\n\n+ question, page_number\n\n**Important** \nOnly simple field types can be prefilled through the `answers` array when publishing. This list is specific to the publish action and differs from the [field types supported on the campaign itself](#group-campaigns-question-types). Below is the list of the supported types:\n\n| question_type | Type | Description |\n|---------------|:--------------:|-------------|\n| text | string | Supports basic HTML formatting when used as readonly |\n| textarea | string | Supports basic HTML formatting when used as readonly |\n| number | number | |\n| photo | URL | External image URL only (binary upload not supported) |\n| multiphotos | array of URLs | External image URLs only (binary upload not supported) |\n| select | string | Single value chosen from the `values` defined in the campaign's form |\n| selectmulti | array | Multiple values chosen from the `values` defined in the campaign's form |\n| selectbuttons | array | Multiple values chosen from the `values` defined in the campaign's form |\n| checkbox | boolean | |\n| toggle | boolean | |\n\nOnly the types listed above are supported; any other type is unsupported at publish, including User, Site, Table, Dataset, Formula & advanced formula, Action, Catalogue, Learn and Information fields, as well as any newly added field type not explicitly listed here.\n\nThere are two ways to publish a campaign of type `mission`:\n\n- If you have a specific store or list of stores to target, you can specify in the body of the request one of the following:\n\n + store_ids\n\n + store_client_ids\n\n + store_type_ids\n\n- If you have already configured the campaign’s audience in the Campaign’s menu from the user interface, it is possible to publish the campaign on all the stores of the audience, only the stores where a mission from this campaign is not available (`skip_when_available: true`), or only the stores where no mission from this campaign exisits (`skip_when_exists: true`).\n\n**Important** \nIt is required to have either:\n\n+ At least one active filter with the \"Select all\" function activated to publish on the selection.\n\n+ At least one store manually selected.\n\nIf nothing is selected in the Campaign’s configuration (filters or manual selection) and no stores were specified in the request’s body, then an error will be returned.", "tags": [ "Campaigns" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "store_client_ids": { "type": "array", "items": { "type": "string" } }, "answers": { "type": "array", "items": { "type": "object", "properties": { "question_id": { "type": "string" }, "question_type": { "type": "string" }, "question": { "type": "string" }, "page_number": { "type": "number" }, "answer": { "items": { "type": "string" }, "oneOf": [ { "type": "array", "items": {} }, { "type": "number" } ] } }, "required": [ "question_type", "question", "page_number", "answer" ] } } }, "example": { "store_client_ids": [ "client_100", "client_101", "client_102" ], "answers": [ { "question_id": "8d6d072d-4dcc-42e5-9243-be149b5ef9bb", "question_type": "selectmulti", "question": "Multiple choice", "page_number": 1, "answer": [ "2" ] }, { "question_type": "number", "question": "Number", "page_number": 3, "answer": 9 } ] } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/campaigns/{id}/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export data for a Campaign", "operationId": "Export data for a Campaign", "description": "Exports the data from the missions that have been published for this campaign.\n\n#### Exported Fields\n\nThe result file contains generic [`mission fields`](#group-missions-fields) as well as specific columns for each of the questions defined on the campaign. The name of the field for each question is the `question_id`. \nClick here to download an excel file example. \n**Important:**\nThe result file contains 2 header rows. The second header row contains additional data from the corresponding question with the format `Working test
",
"community_id": "667ac0b15ba1350028ac0b99",
"user_id": "66150878202c1cfafdb4f8f5",
"publish_type": "postnow",
"publish_date": "2025-01-07T14:57:32.036Z",
"created_date": "2025-01-07T14:57:32.122Z",
"updated_date": "2025-01-07T14:57:32.122Z"
}
},
"examples": {
"response": {
"value": {
"post_id": "677d40dc0241bb002127310f",
"description": "Working test
",
"community_id": "667ac0b15ba1350028ac0b99",
"user_id": "66150878202c1cfafdb4f8f5",
"publish_type": "postnow",
"publish_date": "2025-01-07T14:57:32.036Z",
"created_date": "2025-01-07T14:57:32.122Z",
"updated_date": "2025-01-07T14:57:32.122Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a post for a given id",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the post",
"required": true,
"example": "677d40dc0241bb002127310f",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/community-posts/?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Get all posts",
"operationId": "Get all posts",
"description": "Get all posts.",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{\"where\":{\"community_id\": \"667ac0b15ba1350028ac0b99\"}}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/community-posts/{community_post_id}/comments?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Get all post comments",
"operationId": "Get all post comments",
"description": "Get all post comments.",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{\"where”:{\"comment\": \"I want to join\"}}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/community-posts": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"post_id": {
"type": "string"
},
"description": {
"type": "string"
},
"community_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"publish_type": {
"type": "string"
},
"publish_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"post_id": "677e3e49b855a6001ff46388",
"description": "Welcome everyone!
",
"community_id": "667ac0b15ba1350028ac0b99",
"user_id": "6628ed6adc1960a7aa5c7ce4",
"publish_type": "postnow",
"publish_date": "2025-01-08T07:57:32.036Z",
"created_date": "2025-01-08T08:58:49.102Z",
"updated_date": "2025-01-08T08:58:49.102Z"
}
},
"examples": {
"response": {
"value": {
"post_id": "677e3e49b855a6001ff46388",
"description": "Welcome everyone!
",
"community_id": "667ac0b15ba1350028ac0b99",
"user_id": "6628ed6adc1960a7aa5c7ce4",
"publish_type": "postnow",
"publish_date": "2025-01-08T07:57:32.036Z",
"created_date": "2025-01-08T08:58:49.102Z",
"updated_date": "2025-01-08T08:58:49.102Z"
}
}
}
}
}
}
},
"summary": "Create a post",
"operationId": "Create a post",
"description": "Create a post",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"community_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"publish_type": {
"type": "string"
},
"publish_date": {
"type": "string"
}
},
"example": {
"description": "Welcome everyone!
",
"community_id": "667ac0b15ba1350028ac0b99",
"user_id": "6628ed6adc1960a7aa5c7ce4",
"publish_type": "postnow",
"publish_date": "2025-01-08T07:57:32.036Z"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/community-posts/{community_post_id}/comments": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"date": {
"type": "string"
},
"comment": {
"type": "string"
},
"community_id": {
"type": "string"
},
"community_post_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"comment_id": "677e3f43b855a6001ff464a7",
"user_id": "6628ed6adc1960a7aa5c7ce4",
"date": "2025-01-08T09:02:59.707Z",
"comment": "Good to know :)",
"community_id": "667ac0b15ba1350028ac0b99",
"community_post_id": "677ba82156e14b001e8cab37",
"created_date": "2025-01-08T09:02:59.728Z",
"updated_date": "2025-01-08T09:02:59.728Z"
}
},
"examples": {
"response": {
"value": {
"comment_id": "677e3f43b855a6001ff464a7",
"user_id": "6628ed6adc1960a7aa5c7ce4",
"date": "2025-01-08T09:02:59.707Z",
"comment": "Good to know :)",
"community_id": "667ac0b15ba1350028ac0b99",
"community_post_id": "677ba82156e14b001e8cab37",
"created_date": "2025-01-08T09:02:59.728Z",
"updated_date": "2025-01-08T09:02:59.728Z"
}
}
}
}
}
}
},
"summary": "Create a post comment",
"operationId": "Create a post comment",
"description": "Create a post comment",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"example": {
"user_id": "6628ed6adc1960a7aa5c7ce4",
"comment": "Good to know :)"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/community-posts/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/community-posts/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Community Posts"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/competencies/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"competency_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"title": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"competency_id": "61bb34a35f12370025d998da",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "new test competency ",
"tenant": "testproductv6_boost",
"created_date": "2021-12-16T12:44:19.018Z",
"updated_date": "2021-12-16T12:44:19.018Z"
}
},
"examples": {
"response": {
"value": {
"competency_id": "61bb34a35f12370025d998da",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "new test competency ",
"tenant": "testproductv6_boost",
"created_date": "2021-12-16T12:44:19.018Z",
"updated_date": "2021-12-16T12:44:19.018Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a competency for the given id.",
"tags": [
"Competencies"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the competency",
"required": true,
"example": "5c6e7bd9d6313e003a5b73e1",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/competencies?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competency_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"title": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"competency_id",
"creator_id",
"title",
"tenant",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"competency_id": "61bb34a35f12370025d998da",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "new test competency ",
"tenant": "testproductv6_boost",
"created_date": "2021-12-16T12:44:19.018Z",
"updated_date": "2021-12-16T12:44:19.018Z"
},
{
"competency_id": "61b8de7f18a1d2002905c610",
"creator_id": "61af7b01ee30bd0025145674",
"title": "this is a new competency ",
"tenant": "new_security_tenant",
"created_date": "2021-12-14T18:12:15.385Z",
"updated_date": "2021-12-14T18:12:15.385Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"competency_id": "61bb34a35f12370025d998da",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "new test competency ",
"tenant": "testproductv6_boost",
"created_date": "2021-12-16T12:44:19.018Z",
"updated_date": "2021-12-16T12:44:19.018Z"
},
{
"competency_id": "61b8de7f18a1d2002905c610",
"creator_id": "61af7b01ee30bd0025145674",
"title": "this is a new competency ",
"tenant": "new_security_tenant",
"created_date": "2021-12-14T18:12:15.385Z",
"updated_date": "2021-12-14T18:12:15.385Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the competencies.",
"tags": [
"Competencies"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/competencies/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Competencies"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/competencies/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Competencies"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/course-categories/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"title": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"category_id": "61c058d4d1ae7c00388ef198",
"creator_id": "5f3cfa761e8fdf003bf1fab7",
"title": "Sales AI",
"tenant": "vitaltest",
"created_date": "2021-12-20T10:20:04.206Z",
"updated_date": "2021-12-20T10:20:04.206Z"
}
},
"examples": {
"response": {
"value": {
"category_id": "61c058d4d1ae7c00388ef198",
"creator_id": "5f3cfa761e8fdf003bf1fab7",
"title": "Sales AI",
"tenant": "vitaltest",
"created_date": "2021-12-20T10:20:04.206Z",
"updated_date": "2021-12-20T10:20:04.206Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a course for the given id.",
"tags": [
"Course Categories"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the course",
"required": true,
"example": "5c6e7bd9d6313e003a5b73e1",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/course-categories?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"title": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"category_id",
"creator_id",
"title",
"tenant",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"category_id": "61b86bea8300b200252164e4",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "hello",
"tenant": "testproductv6_boost",
"created_date": "2021-12-14T10:03:22.232Z",
"updated_date": "2021-12-14T10:03:22.232Z"
},
{
"category_id": "61aa12c62e6c8a003d8f71c2",
"creator_id": "61125f8d7e10d10034973329",
"title": "Blabla",
"tenant": "testproduct",
"created_date": "2021-12-03T12:51:18.855Z",
"updated_date": "2021-12-03T12:51:18.855Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"category_id": "61b86bea8300b200252164e4",
"creator_id": "5e1356f0c5f0e0003d305072",
"title": "hello",
"tenant": "testproductv6_boost",
"created_date": "2021-12-14T10:03:22.232Z",
"updated_date": "2021-12-14T10:03:22.232Z"
},
{
"category_id": "61aa12c62e6c8a003d8f71c2",
"creator_id": "61125f8d7e10d10034973329",
"title": "Blabla",
"tenant": "testproduct",
"created_date": "2021-12-03T12:51:18.855Z",
"updated_date": "2021-12-03T12:51:18.855Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the course-categories.",
"tags": [
"Course Categories"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/course-categories/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Course Categories"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/course-categories/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Course Categories"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/courses/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"course_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"assignment_date": {
"type": "string"
},
"earned_points": {
"type": "number"
},
"start_date": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"duration": {
"type": "number"
},
"due_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"course_id": "5c6e7bd9d6313e003a5b73e1",
"user_id": "5c46fccd73b0240042c8d1cd",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:17.130Z",
"earned_points": 0,
"start_date": "2019-02-22T09:00:00.000Z",
"finished_date": "2019-02-22T10:00:00.000Z",
"duration": 60,
"due_date": "2019-03-01T08:00:00.000Z",
"created_date": "2019-02-21T10:22:17.136Z",
"updated_date": "2019-02-21T10:22:17.136Z"
}
},
"examples": {
"response": {
"value": {
"course_id": "5c6e7bd9d6313e003a5b73e1",
"user_id": "5c46fccd73b0240042c8d1cd",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:17.130Z",
"earned_points": 0,
"start_date": "2019-02-22T09:00:00.000Z",
"finished_date": "2019-02-22T10:00:00.000Z",
"duration": 60,
"due_date": "2019-03-01T08:00:00.000Z",
"created_date": "2019-02-21T10:22:17.136Z",
"updated_date": "2019-02-21T10:22:17.136Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a course for the given id.",
"tags": [
"Courses"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the course",
"required": true,
"example": "5c6e7bd9d6313e003a5b73e1",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/courses?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"course_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"assignment_date": {
"type": "string"
},
"earned_points": {
"type": "number"
},
"start_date": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"due_date": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"course_id",
"user_id",
"plan_id",
"assignment_date",
"tenant",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"course_id": "5c6e7bd9d6313e003a5b73e1",
"user_id": "5c46fccd73b0240042c8d1cd",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:17.130Z",
"earned_points": 0,
"start_date": "2019-02-22T09:08:54.000Z",
"finished_date": "2019-02-22T09:08:54.000Z",
"due_date": "2019-03-01T08:00:00.000Z",
"tenant": "boost_cs",
"created_date": "2019-02-21T10:22:17.136Z",
"updated_date": "2019-02-21T10:22:17.136Z"
},
{
"course_id": "5c6e7bcdd6313e003a5b73cc",
"user_id": "5c46fccc73b0240042c8d1ca",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:05.160Z",
"tenant": "boost_cs",
"created_date": "2019-02-21T10:22:05.163Z",
"updated_date": "2019-02-21T10:22:05.163Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"course_id": "5c6e7bd9d6313e003a5b73e1",
"user_id": "5c46fccd73b0240042c8d1cd",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:17.130Z",
"earned_points": 0,
"start_date": "2019-02-22T09:08:54.000Z",
"finished_date": "2019-02-22T09:08:54.000Z",
"due_date": "2019-03-01T08:00:00.000Z",
"tenant": "boost_cs",
"created_date": "2019-02-21T10:22:17.136Z",
"updated_date": "2019-02-21T10:22:17.136Z"
},
{
"course_id": "5c6e7bcdd6313e003a5b73cc",
"user_id": "5c46fccc73b0240042c8d1ca",
"plan_id": "5c5b09bb924daa006bafb347",
"assignment_date": "2019-02-21T10:22:05.160Z",
"tenant": "boost_cs",
"created_date": "2019-02-21T10:22:05.163Z",
"updated_date": "2019-02-21T10:22:05.163Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the courses.",
"tags": [
"Courses"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/courses/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Courses"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/courses/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Courses"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/custom-model-instances/export?custom_model_id={custom_model_id}&type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Custom Model Instances - Datasets"
],
"parameters": [
{
"name": "custom_model_id",
"in": "path",
"description": "The inventory for all instances of this export",
"required": true,
"example": "54ab03c6546847ee0d37143b",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/custom-model-instances/import?custom_model_id={custom_model_id}&type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|-----------------------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`custom_model_instances_id` | string | | | | Unique identifier |",
"tags": [
"Custom Model Instances - Datasets"
],
"parameters": [
{
"name": "custom_model_id",
"in": "path",
"description": "The inventory for all instances of this import",
"required": true,
"example": "54ab03c6546847ee0d37143b",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/events/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a event for the given id.",
"tags": [
"Events"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the event",
"required": true,
"example": "61b9b435c8f864003a552378",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"event_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"event_type": {
"type": "string"
},
"images": {
"type": "array",
"items": {}
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"timezone": {
"type": "string"
}
},
"example": {
"event_id": "62876c7ad1d606003e43d8bc",
"title": "private event",
"description": "update description",
"start_date": "2022-05-23T10:24:00.000Z",
"end_date": "2022-05-23T15:25:00.000Z",
"event_type": "private",
"images": [],
"created_date": "2022-05-20T10:24:58.655Z",
"updated_date": "2022-05-20T10:24:58.655Z",
"user_ids": [
"5f23dc9e342004004927778e",
"5f3cfa761e8fdf003bf1faba",
"628361451008ce002508afe1",
"628364ac1008ce00250a18c2"
],
"tags": [
"event_tag"
],
"timezone": "America/New_York"
}
},
"examples": {
"response": {
"value": {
"event_id": "62876c7ad1d606003e43d8bc",
"title": "private event",
"description": "update description",
"start_date": "2022-05-23T10:24:00.000Z",
"end_date": "2022-05-23T15:25:00.000Z",
"event_type": "private",
"images": [],
"created_date": "2022-05-20T10:24:58.655Z",
"updated_date": "2022-05-20T10:24:58.655Z",
"user_ids": [
"5f23dc9e342004004927778e",
"5f3cfa761e8fdf003bf1faba",
"628361451008ce002508afe1",
"628364ac1008ce00250a18c2"
],
"tags": [
"event_tag"
],
"timezone": "America/New_York"
}
}
}
}
}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of an event",
"tags": [
"Events"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the event",
"required": true,
"example": "61b9b435c8f864003a552378",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"description": "The id of the event",
"required": true,
"example": "62876c7ad1d606003e43d8bc",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"example": {
"tags": [
"event_tag"
],
"description": "update description",
"timezone": "America/New_York"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete an event by id.",
"tags": [
"Events"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the event",
"required": true,
"example": "61b9b435c8f864003a552378",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/events/{id}/invitees": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Invitees",
"operationId": "Invitees",
"description": "Export list of invitees of an event.\n\n| Field | Format | Description |\n|-------------|--------|-------------------------------------------|\n| user_id | string | id of the user |\n| username | string | username of the user |\n| email | string | email of the user |\n| first_name | string | first name of the user |\n| last_name | string | last name of the user |\n| attendance | string | attendance status of the user:• `null` if no answer from user
• `join`
• `maybe`
• `decline` |", "tags": [ "Events" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the event", "required": true, "example": "62876c7ad1d606003e43d8bc", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/events?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "skip": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "event_type": { "type": "string" }, "images": { "type": "array", "items": {} }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "shared": { "type": "boolean" } }, "required": [ "event_id", "title", "description", "start_date", "end_date", "event_type", "images", "shared", "created_date", "updated_date", "group_ids" ] } } }, "example": { "paging": { "skip": 0, "limit": 2, "total": 5 }, "data": [ { "event_id": "62a0c411fcbce30026aee2c8", "title": "Share to newsfeed event", "description": "shared in feed", "start_date": "2022-06-08T15:45:14.688Z", "end_date": "2022-06-08T16:45:18.434Z", "event_type": "public", "images": [], "created_date": "2022-06-08T15:45:21.045Z", "updated_date": "2022-06-08T16:20:56.579Z", "group_ids": [ "documetation_api" ], "shared": true }, { "event_id": "62a0c83271670d71266b9a55", "title": "Don't share to newsfeed", "description": "
Is it working?
",
"start_date": "2022-06-08T15:45:14.688Z",
"end_date": "2022-06-08T16:45:18.434Z",
"event_type": "public",
"images": [],
"shared": false,
"created_date": "2022-06-08T16:02:58.878Z",
"updated_date": "2022-06-08T16:20:56.028Z",
"group_ids": [
"documetation_api"
]
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"skip": 0,
"limit": 2,
"total": 5
},
"data": [
{
"event_id": "62a0c411fcbce30026aee2c8",
"title": "Share to newsfeed event",
"description": "shared in feed",
"start_date": "2022-06-08T15:45:14.688Z",
"end_date": "2022-06-08T16:45:18.434Z",
"event_type": "public",
"images": [],
"created_date": "2022-06-08T15:45:21.045Z",
"updated_date": "2022-06-08T16:20:56.579Z",
"group_ids": [
"documetation_api"
],
"shared": true
},
{
"event_id": "62a0c83271670d71266b9a55",
"title": "Don't share to newsfeed",
"description": "Is it working?
",
"start_date": "2022-06-08T15:45:14.688Z",
"end_date": "2022-06-08T16:45:18.434Z",
"event_type": "public",
"images": [],
"shared": false,
"created_date": "2022-06-08T16:02:58.878Z",
"updated_date": "2022-06-08T16:20:56.028Z",
"group_ids": [
"documetation_api"
]
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the events.",
"tags": [
"Events"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/events": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"event_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"event_type": {
"type": "string"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"type": "string"
},
"store_id": {
"type": "string"
}
},
"example": {
"event_id": "5f3e4be0c920a5003b57bbed",
"title": "EVENT 1",
"description": "This is my new description 1
",
"start_date": "2022-05-29T08:00:00.000Z",
"end_date": "2022-05-29T13:00:00.000Z",
"event_type": "public",
"group_ids": [
"documentation_admin",
"documentation_stores"
],
"images": [
"test.jpg"
],
"category": "EVENTCATEGORY1",
"store_id": "5f3e4be0c920a5003b57bbec"
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single or multiple events using this action.\nWhen creating a single event object the body contains a json object, when creating multiple events objects the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"Events"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"event_type": {
"type": "string"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"type": "string"
},
"store_id": {
"type": "string"
}
},
"example": {
"title": "EVENT 1",
"description": "This is my new description 1
",
"start_date": "2022-05-29T08:00:00.000Z",
"end_date": "2022-05-29T13:00:00.000Z",
"event_type": "public",
"group_ids": [
"documentation_admin",
"documentation_stores"
],
"images": [
"test.jpg"
],
"category": "EVENTCATEGORY1",
"store_id": "5f3e4be0c920a5003b57bbec"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/events/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Events"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/events/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Events"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/events/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "### Fields\n\n| Field | Format | Required | Description |\n|----------------------|:--------------:|:--------:|:--------------------------|\n|`event_id` | string | | Unique id of the event |\n|`title` | string | x | The title of the event |\n|`description` | string | x | The description of the event. HTML can be used for formatting|\n|`start_date` | date | x | Start date of the event in UTC|\n|`end_date` | date | x | End date of the event in UTC|\n|`event_type` | string | x | `private` or `public` |\n|`all_day` | boolean | | `true` or `false`. if `true`, start_date should equal to end_date|\n|`tags` | array | | Event’s list of tags |\n|`category` | string | | Category of the event. Must match the title of an existing event category|\n|`user_ids` | array | | Required for private events only. Ignored for public events. User ids that are invited to this event|\n|`usernames` | array | | For private events: usernames of the users invited to this event. Alternative to `user_ids`. Populated on export|\n|`group_ids` | array | | | Required for public events. Ignored for private events. Group ids of users who should be invited to this event|\n|`images` | array | | | Links to uploaded images. Used as illustration on the event page. Max 3 images per event|\n|`store_id` | string | | Store the event is linked to|\n|`shared_in_newsfeed` | boolean | | If event shared on feeds (true/false). Default `false`|\n|`is_assigned_event_type`| boolean | | `true` or `false`. Marks the event as an assigned event type|\n|`is_informative` | boolean | | `true` or `false`. Informative event. Default `false`|\n|`video_urls` | array | | Links to uploaded videos|\n|`audio_urls` | array | | Links to uploaded audio files|\n|`file_ids` | array | | Ids of documents attached to the event|\n|`campaign_id` | string | | Id of the campaign linked to the event|\n|`is_share_location` | boolean | | `true` or `false`. Share the event location|\n|`location_type` | string | | Location type the event is linked to|\n|`users_query` | object | | Query object used to compute the invited users|\n|`use_users_query` | boolean | | `true` or `false`. If `true` the invitees are computed from `users_query`|\n|`recurrence` | object | | Recurrence rule of the event|\n|`disable_notifications`| boolean | | `true` or `false`. Disable notifications for this event. Default `false`|\n|`disable_likes` | boolean | | `true` or `false`. Disable likes on this event. Default `true`|\n|`disable_reactions` | boolean | | `true` or `false`. Disable reactions on this event. Default `true`|\n|`disable_comments` | boolean | | `true` or `false`. Disable comments on this event. Default `true`|\n|`creator_id` | string | | User id of the event creator|\n|`created_date` | date | | Creation date |\n|`updated_date` | date | | Last update date |",
"tags": [
"Events"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/files/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"file_id": {
"type": "string"
},
"folder_id": {
"type": "string"
},
"folder_name": {
"type": "string"
},
"size": {
"type": "number"
},
"filename": {
"type": "string"
},
"download_url": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
},
"examples": {
"response": {
"value": {
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a file for the given id.",
"tags": [
"Files"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the file",
"required": true,
"example": "54ab03c6546847ee0d30087d",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/files": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"file_id": {
"type": "string"
},
"folder_id": {
"type": "string"
},
"folder_name": {
"type": "string"
},
"size": {
"type": "number"
},
"filename": {
"type": "string"
},
"download_url": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
},
"examples": {
"response": {
"value": {
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "Upload a file in YOOBIC Documents.\n\nTo upload a photo, you should make a post request of type multipart/form-data. The request body should contain two fields:\n\n- `file`: the binary file you want to upload.\n\n- `group_ids`: select the groups that will have visibility of the file.\n\n- Optionally, `folder_id`: select the parent folder to upload the file.\n\n![](\"https://assets.yoobic.com/image/upload/v1769336454/jpjdfb7mhrnmgisymkmf.png\")
",
"tags": [
"Files"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/files?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_id": {
"type": "string"
},
"folder_id": {
"type": "string"
},
"folder_name": {
"type": "string"
},
"size": {
"type": "number"
},
"filename": {
"type": "string"
},
"download_url": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"file_id",
"folder_id",
"folder_name",
"size",
"filename",
"download_url",
"mime_type",
"created_date",
"updated_date"
]
},
"example": [
{
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
},
{
"file_id": "54ab03c6546847ee0d30087e",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 2",
"download_url": "www.rocketltd.com/file/RocketsFile2.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
]
},
"examples": {
"response": {
"value": [
{
"file_id": "54ab03c6546847ee0d30087d",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 1",
"download_url": "www.rocketltd.com/file/RocketsFile1.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
},
{
"file_id": "54ab03c6546847ee0d30087e",
"folder_id": "54ab03c6546847ee0d30087b",
"folder_name": "Rockets folder",
"size": 25,
"filename": "Rockets file 2",
"download_url": "www.rocketltd.com/file/RocketsFile2.jpg",
"mime_type": "jpg",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z"
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the files.",
"tags": [
"Files"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/files/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Files"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/files/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Files"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/geofilters/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"geofilter_id": {
"type": "string"
},
"store_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"store_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12cd33",
"551da1d6e846db5b384876e3",
"551d6addc5ba3e1c05027f75",
"551d6adddf86ce073a80903b",
"551d6add6356be82480274c0",
"551d6add2c35374276027fe9",
"54f06ac41e93dff83d000857"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T16:55:17.563Z",
"updated_date": "2015-09-07T09:10:58.643Z"
}
},
"examples": {
"response": {
"value": {
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12cd33",
"551da1d6e846db5b384876e3",
"551d6addc5ba3e1c05027f75",
"551d6adddf86ce073a80903b",
"551d6add6356be82480274c0",
"551d6add2c35374276027fe9",
"54f06ac41e93dff83d000857"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T16:55:17.563Z",
"updated_date": "2015-09-07T09:10:58.643Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a geofilter for the given id.",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete a geofilter by id.",
"tags": [
"Geofilters"
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"geofilter_id": {
"type": "string"
},
"store_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"store_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
}
},
"examples": {
"response": {
"value": {
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
}
}
}
}
}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of a geofilter",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"store_client_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"store_client_ids": [
"ice-cream-store-10"
]
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/geofilters?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"geofilter_id": {
"type": "string"
},
"store_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"store_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"geofilter_id",
"store_ids",
"user_id",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
},
{
"geofilter_id": "552168f5f8d75fe77c520e80",
"store_ids": [
"551d6add1077d5fb7a12ab02",
"551d6add1077d5fb7a12ab03"
],
"user_id": "55142883b0cc8a622d01c5a2",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:40:58.643Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"store_type_ids": [
"551c1b9b11cbd1e27819ea0f",
"551bc51e0a122f7f73e04ba7",
"551b1a44e829ce22380028f4",
"54357be802d0e9fa0202e9a2"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
},
{
"geofilter_id": "552168f5f8d75fe77c520e80",
"store_ids": [
"551d6add1077d5fb7a12ab02",
"551d6add1077d5fb7a12ab03"
],
"user_id": "55142883b0cc8a622d01c5a2",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:40:58.643Z"
}
]
}
}
}
}
}
}
},
"summary": "Get all",
"operationId": "Get all",
"description": "Get all geofilters.",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/geofilters/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/geofilters": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"geofilter_id": {
"type": "string"
},
"store_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"geofilter_id",
"store_ids",
"user_id",
"created_date",
"updated_date"
]
},
"example": [
{
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
},
{
"geofilter_id": "552168f5f8d75fe77c520e80",
"store_ids": [
"551d6add1077d5fb7a12ab03"
],
"user_id": "55142883b0cc8a622d01c5a2",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:40:58.643Z"
}
]
},
"examples": {
"response": {
"value": [
{
"geofilter_id": "552168f5f8d75fe77c520e7f",
"store_ids": [
"551d6add1077d5fb7a12ab01"
],
"user_id": "55142883b0cc8a622d01c5a1",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:30:58.643Z"
},
{
"geofilter_id": "552168f5f8d75fe77c520e80",
"store_ids": [
"551d6add1077d5fb7a12ab03"
],
"user_id": "55142883b0cc8a622d01c5a2",
"created_date": "2015-04-05T01:55:17.563Z",
"updated_date": "2015-09-07T11:40:58.643Z"
}
]
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single geofilter or multiple geofilters using this action. \nWhen creating a single geofilter the body contains a json object, when creating multiple geofilters the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"store_type_names": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
}
},
"example": {
"store_type_names": [
"yoobic-ice-creams"
],
"user_id": "5babb8a69fa6ae919f675716"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/geofilters/export?{filter}&type={type}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/geofilters/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n|`geofilter_id` | string | | Unique geofilter id |\n|`user_id` | string | x | Unique user id |\n|`store_ids` | array | x | Unique store ids|\n|`store_client_ids` | array | | External unique ids of the stores as it may exists in your Information System|\n|`store_type_names` | array | | The names of the store types|\n|`store_type_ids` | array | | The ids of the store types|\n\nOne of either fields is required in order to resolve the mapping between a user and store/s:\n\n- store_ids\n\n- store_client_ids\n\n- store_type_ids\n\n- store_type_names",
"tags": [
"Geofilters"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/groups/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-05-22T11:45:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "My Company Title",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-05-22T11:45:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "My Company Title",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a group for the given id.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete a group by id.",
"tags": [
"Groups"
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"title": "My New Company Title",
"description": "My New Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"title": "My New Company Title",
"description": "My New Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
}
}
}
}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of a group.\n\n**Important:**\nIt is not possible to update `group_ids` or `user_ids` through this endpoint. To update these properties, please read the endpoints above.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"example": {
"title": "My New Company Title",
"description": "My New Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/groups/{id}/groups": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"group_ids": [
"mycompany_mycompany_group_1",
"mycompany_mycompany_group_2"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"group_ids": [
"mycompany_mycompany_group_1",
"mycompany_mycompany_group_2"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
}
}
}
}
}
},
"summary": "Add Groups to Group",
"operationId": "Add Groups to Group",
"description": "Add groups to a group",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
}
}
}
}
}
},
"summary": "Remove Groups from Group",
"operationId": "Remove Groups from Group",
"description": "Remove groups from a group",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/groups/{id}/users": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a",
"53fb03c6546847ee0d33387c",
"53fb03c6546847ee0d33387d"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a",
"53fb03c6546847ee0d33387c",
"53fb03c6546847ee0d33387d"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
}
}
}
}
}
},
"summary": "Add Users to Group",
"operationId": "Add Users to Group",
"description": "Add users to a group",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"example": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
},
"examples": {
"response": {
"value": {
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
}
}
}
}
}
},
"summary": "Remove Users from Group",
"operationId": "Remove Users from Group",
"description": "Remove users from a group",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/groups?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"required": [
"group_id",
"user_ids",
"updated_date",
"created_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "My Company Title",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
},
{
"group_id": "mycompany_another_test_group",
"user_ids": [
"53fb03c6546847ee0d33387b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"group_id": "mycompany_test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "My Company Title",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
},
{
"group_id": "mycompany_another_test_group",
"user_ids": [
"53fb03c6546847ee0d33387b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the groups.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/group/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Groups"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/groups": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"group_id",
"user_ids",
"title",
"updated_date",
"created_date"
]
},
"example": [
{
"group_id": "mycompany_sub-test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "sub-test",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
},
{
"group_id": "mycompany_my_company_title",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"group_ids": [
"mycompany_sub-test"
],
"title": "My Company Title",
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
]
},
"examples": {
"response": {
"value": [
{
"group_id": "mycompany_sub-test",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z",
"title": "sub-test",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
},
{
"group_id": "mycompany_my_company_title",
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"group_ids": [
"mycompany_sub-test"
],
"title": "My Company Title",
"updated_date": "2018-10-08T10:15:22.100Z",
"created_date": "2018-05-22T11:45:22.100Z"
}
]
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single group or multiple groups using this action.\nWhen creating a single group the body contains a json object, when creating multiple groups the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**\n\n**Important:**\nThe `group_id` is generated automatically when a new group is created. The `group_id` corresponds to the group's title in lowercase letters, with `_` instead of spaces, and without special caracters",
"tags": [
"Groups"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"example": {
"user_ids": [
"53fb03c6546847ee0d33386b",
"53fb03c6546847ee0d30086a"
],
"title": "My Company Title",
"description": "My Company Description",
"icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/groups/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/groups/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.\n\n**Important:**\nThe `group_id` is generated automatically when a new group is created. The `group_id` corresponds to the Group title in lowercase letters, with `_` instead of spaces, and without special caracters\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:---------:|-----------------|\n|`group_id` | string | | Unique group name/id |\n|`user_ids` | array | | User ids of the group |\n|`group_ids` | array | | Sub group ids of the group|\n|`title` | string | x | Group Title|\n|`description` | string | | Group Description|\n|`icon_url` | string | | Icon URL|",
"tags": [
"Groups"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/incentives-kpi/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incentive_kpi_id": {
"type": "string"
},
"incentive_id": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"participant_id": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"weight": {
"type": "number"
},
"participant_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 12,
"count": 6,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:10:00.000Z"
}
},
"examples": {
"response": {
"value": {
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 12,
"count": 6,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:10:00.000Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get an incentive-kpi for the given id.",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the incentive-kpi",
"required": true,
"example": "5eb8fd0a7d5ff5748adcb039",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete an incentive-kpi by id.",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the incentive-kpi",
"required": true,
"example": "5eb8fd0a7d5ff5748adcb039",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incentive_kpi_id": {
"type": "string"
},
"incentive_id": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"participant_id": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"weight": {
"type": "number"
},
"participant_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 10,
"count": 5,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:35:00.000Z"
}
},
"examples": {
"response": {
"value": {
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 10,
"count": 5,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:35:00.000Z"
}
}
}
}
}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of an incentive-kpi",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the incentive-kpi",
"required": true,
"example": "5eb8fd0a7d5ff5748adcb039",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"description": "The id of the incentive-kpi",
"required": true,
"example": "5eb8fd0a7d5ff5748adcb039",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
}
},
"example": {
"total": 10,
"count": 5
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/incentives-kpi?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"incentive_kpi_id": {
"type": "string"
},
"incentive_id": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"participant_id": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"weight": {
"type": "number"
},
"participant_type": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"product_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"price": {
"type": "number"
}
},
"required": [
"incentive_kpi_id",
"incentive_id",
"participant_id",
"owner_id",
"first_name",
"last_name",
"username",
"start_time",
"end_time",
"total",
"count",
"weight",
"participant_type",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 10,
"count": 5,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:35:00.000Z"
},
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb096",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"participant_id": "api_team",
"product_id": "5eb8fd017d5ff5748adcaef5",
"product_name": "myproduct",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 20,
"count": 2,
"weight": 2,
"price": 5,
"participant_type": "teams",
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
"incentive_id": "5eb8fd017d5ff5748adcaf09",
"owner_id": "5eb8fd017d5ff5748adcaef5",
"first_name": "my",
"last_name": "company",
"username": "mcompany@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef5",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 10,
"count": 5,
"weight": 2,
"participant_type": "individual",
"created_date": "2020-01-01T00:00:00.000Z",
"updated_date": "2020-01-01T00:35:00.000Z"
},
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb096",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"participant_id": "api_team",
"product_id": "5eb8fd017d5ff5748adcaef5",
"product_name": "myproduct",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 20,
"count": 2,
"weight": 2,
"price": 5,
"participant_type": "teams",
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the incentive-kpis.",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/incentives-kpi/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/incentives-kpi": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"incentive_kpi_id": {
"type": "string"
},
"incentive_id": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"participant_id": {
"type": "string"
},
"participant_type": {
"type": "string"
},
"total": {
"type": "number"
},
"weight": {
"type": "number"
},
"count": {
"type": "number"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"product_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"price": {
"type": "number"
}
},
"required": [
"incentive_kpi_id",
"incentive_id",
"participant_id",
"owner_id",
"first_name",
"last_name",
"username",
"start_time",
"end_time",
"total",
"count",
"weight",
"participant_type",
"created_date",
"updated_date"
]
},
"example": [
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb097",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"start_time": "2019-05-21T04:51:40.862Z",
"end_time": "2019-05-28T04:51:40.862Z",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef4",
"participant_type": "individual",
"total": 35,
"weight": 5,
"count": 7,
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
},
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb096",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"participant_id": "api_team",
"product_id": "5eb8fd017d5ff5748adcaef5",
"product_name": "myproduct",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 20,
"count": 2,
"weight": 2,
"price": 5,
"participant_type": "teams",
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
}
]
},
"examples": {
"response": {
"value": [
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb097",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"start_time": "2019-05-21T04:51:40.862Z",
"end_time": "2019-05-28T04:51:40.862Z",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"participant_id": "5eb8fd017d5ff5748adcaef4",
"participant_type": "individual",
"total": 35,
"weight": 5,
"count": 7,
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
},
{
"incentive_kpi_id": "5eb8fd147d5ff5748adcb096",
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"participant_id": "api_team",
"product_id": "5eb8fd017d5ff5748adcaef5",
"product_name": "myproduct",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"first_name": "John",
"last_name": "Doe",
"username": "jdoe@mycompany.com",
"start_time": "2020-01-01T00:00:00.000Z",
"end_time": "2020-01-31T23:59:59.999Z",
"total": 20,
"count": 2,
"weight": 2,
"price": 5,
"participant_type": "teams",
"created_date": "2020-05-11T07:21:56.182Z",
"updated_date": "2020-05-11T08:21:56.182Z"
}
]
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single incentives-kpi or multiple incentives-kpi using this action.\nWhen creating a single incentives-kpi the body contains a json object, when creating multiple incentives-kpi the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"incentive_id": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"participant_id": {
"type": "string"
},
"participant_type": {
"type": "string"
},
"total": {
"type": "number"
},
"weight": {
"type": "number"
},
"count": {
"type": "number"
}
},
"example": {
"incentive_id": "5eb8fd017d5ff5748adcaf08",
"start_time": "2019-05-21T04:51:40.862Z",
"end_time": "2019-05-28T04:51:40.862Z",
"owner_id": "5eb8fd017d5ff5748adcaef4",
"participant_id": "5eb8fd017d5ff5748adcaef4",
"participant_type": "individual",
"total": 35,
"weight": 5,
"count": 7
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/incentives-kpi/export?{filter}&type={type}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/incentives-kpi/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Type | Required | Readonly | OrderBy | Description |\n|----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------|\n|`incentive_kpi_id` | string | | x | | Unique id incentive_kpi |\n|`incentive_id` | string | x | | | The incentive_id |\n|`participant_type` | string | x | | | Type of incentives-kpi ('individual' or 'team') |\n|`participant_user_id` | string | | | | The participant user in kpi |\n|`participant_group_id`| string | | | | The participant group in kpi |\n|`product_id` | string | | | | product_id involved in the kpi |\n|`product_name` | string | | x | | The product's name |\n|`owner_id` | string | x | | | The user who submitted the kpi |\n|`username` | string | | x | | The owner username |\n|`first_name` | string | | x | | The owner first name |\n|`last_name` | string | | x | | The owner last name |\n|`start_time` | date | x | | | The start time of the kpi |\n|`end_time` | date | x | | | The end time of the kpi |\n|`price` | number | | x | | The product's price |\n|`count` | number | | | | Number of units in the kpi|\n|`weight` | number | | x | | Weight of product in total calculation |\n|`total` | number | | | | Total value of the kpi |\n|`created_date` | date | | x | | KPI submission date |\n|`updated_date` | date | | x | x | Last update date |\n\nOnly One of either fields is required (inserting both will fail validation):\n\n- participant_user_id\n\n- participant_group_id\n\nThe rule to define which one to use, is according to the value of `participant_type`.\n\n**Important:**\n\n- If `participant_type` equals `'teams'`, `participant_group_id` must be filled with `group_id` value.\n\n- If `participant_type` equals `'individual'`, `participant_user_id` must be filled with `user_id` value.\n\n- `product_id` is optional and exists only if a product is part of incentives.\n\n- `price` has a value only if a `product_id` exists.\n\n- `start_time` must be before `end_time`.\n\n- `total` is the multiplicity of `count`, `weight` and `price` if `product_id` exists",
"tags": [
"Incentives Kpi"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/inventories/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"inventory_id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"inventory_id": "5c015012ad45490041a52f64",
"title": "Items",
"name": "Grade A products",
"description": "Listing of our A products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
},
"examples": {
"response": {
"value": {
"inventory_id": "5c015012ad45490041a52f64",
"title": "Items",
"name": "Grade A products",
"description": "Listing of our A products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get an inventory for the given id.",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the inventory",
"required": true,
"example": "5c015012ad45490041a52f64",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/inventories?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inventory_id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"inventory_id",
"title",
"name",
"description",
"group_ids",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"inventory_id": "5c015012ad45490041a52f64",
"title": "Items",
"name": "Grade A products",
"description": "Listing of our A products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
},
{
"inventory_id": "5c015012ad45490041a52f65",
"title": "Items",
"name": "Grade B products",
"description": "Listing of our B products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"inventory_id": "5c015012ad45490041a52f64",
"title": "Items",
"name": "Grade A products",
"description": "Listing of our A products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
},
{
"inventory_id": "5c015012ad45490041a52f65",
"title": "Items",
"name": "Grade B products",
"description": "Listing of our B products",
"group_ids": [
"testproduct"
],
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the inventories.",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/inventories/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/inventories/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/lessons/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lesson_id": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"course_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"status": {
"type": "string"
},
"score": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"value": {
"type": "number"
}
}
},
"duration": {
"type": "number"
},
"validated": {
"type": "boolean"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string"
},
"question_type": {
"type": "string"
},
"question": {
"type": "string"
},
"page_number": {
"type": "number"
},
"question_number": {
"type": "number"
},
"answer": {
"type": "number"
}
}
}
}
}
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"lesson_id": "5c7004c1b31ec3003a56af4e",
"title": "Feedback",
"type": "lesson",
"campaign_id": "5c582b8f4a35650044aea049",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"score": {
"total": 0,
"value": 0
},
"duration": 2.3,
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:41.667Z",
"updated_date": "2019-02-22T14:18:41.667Z",
"answers": [
{
"question_id": "e886902d-ddef-43c1-8894-c9f5f101fa56",
"question_type": "feedback",
"question": "Feedback",
"page_number": 1,
"question_number": 1,
"answer": 3
}
]
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"lesson_id": "5c7004c1b31ec3003a56af4e",
"title": "Feedback",
"type": "lesson",
"campaign_id": "5c582b8f4a35650044aea049",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"score": {
"total": 0,
"value": 0
},
"duration": 2.3,
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:41.667Z",
"updated_date": "2019-02-22T14:18:41.667Z",
"answers": [
{
"question_id": "e886902d-ddef-43c1-8894-c9f5f101fa56",
"question_type": "feedback",
"question": "Feedback",
"page_number": 1,
"question_number": 1,
"answer": 3
}
]
}
]
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a lesson for the given id.",
"tags": [
"Lessons"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the lesson",
"required": true,
"example": "5c7004c1b31ec3003a56af4e",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/lessons?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lesson_id": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"course_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"status": {
"type": "string"
},
"score": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"value": {
"type": "number"
},
"isPercentage": {
"type": "boolean"
},
"completed": {
"type": "number"
}
}
},
"validated": {
"type": "boolean"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string"
},
"question_type": {
"type": "string"
},
"question": {
"type": "string"
},
"page_number": {
"type": "number"
},
"question_number": {
"type": "number"
},
"answer": {
"type": "array",
"items": {
"type": "array",
"items": {}
}
}
},
"required": [
"question_id",
"question_type",
"question",
"page_number",
"question_number",
"answer"
]
}
},
"points": {
"type": "number"
}
},
"required": [
"lesson_id",
"title",
"type",
"campaign_id",
"plan_id",
"course_id",
"user_id",
"status",
"score",
"validated",
"tenant",
"created_date",
"updated_date",
"answers"
]
},
"example": [
{
"lesson_id": "5c7004c1b31ec3003a56af4e",
"title": "Feedback",
"type": "lesson",
"campaign_id": "5c582b8f4a35650044aea049",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"score": {
"total": 0,
"value": 0
},
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:41.667Z",
"updated_date": "2019-02-22T14:18:41.667Z",
"answers": [
{
"question_id": "e886902d-ddef-43c1-8894-c9f5f101fa56",
"question_type": "feedback",
"question": "Feedback",
"page_number": 1,
"question_number": 1,
"answer": 3
}
]
},
{
"lesson_id": "5c7004b8b31ec3003a56af0c",
"title": "Categories",
"type": "lesson",
"campaign_id": "5c582b5b4a35650044aea033",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"points": 10,
"score": {
"total": 1,
"value": 100,
"isPercentage": true,
"completed": 1
},
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:32.878Z",
"updated_date": "2019-02-22T14:18:32.878Z",
"answers": [
{
"question_id": "fd91d037-769d-46d8-ac56-059a85db745e",
"question_type": "categorizewords",
"question": "Categorize words",
"page_number": 1,
"question_number": 1,
"answer": [
[
"1",
"2",
"3"
],
[
"A",
"B",
"C"
]
]
}
]
}
]
},
"examples": {
"response": {
"value": [
{
"lesson_id": "5c7004c1b31ec3003a56af4e",
"title": "Feedback",
"type": "lesson",
"campaign_id": "5c582b8f4a35650044aea049",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"score": {
"total": 0,
"value": 0
},
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:41.667Z",
"updated_date": "2019-02-22T14:18:41.667Z",
"answers": [
{
"question_id": "e886902d-ddef-43c1-8894-c9f5f101fa56",
"question_type": "feedback",
"question": "Feedback",
"page_number": 1,
"question_number": 1,
"answer": 3
}
]
},
{
"lesson_id": "5c7004b8b31ec3003a56af0c",
"title": "Categories",
"type": "lesson",
"campaign_id": "5c582b5b4a35650044aea033",
"plan_id": "5bf2d58ae553190041467eef",
"course_id": "5bf4448528b7420041ba9b62",
"user_id": "5beee3717fc4d50043801a97",
"status": "finished",
"points": 10,
"score": {
"total": 1,
"value": 100,
"isPercentage": true,
"completed": 1
},
"validated": true,
"tenant": "testproductv6_boost",
"created_date": "2019-02-22T14:18:32.878Z",
"updated_date": "2019-02-22T14:18:32.878Z",
"answers": [
{
"question_id": "fd91d037-769d-46d8-ac56-059a85db745e",
"question_type": "categorizewords",
"question": "Categorize words",
"page_number": 1,
"question_number": 1,
"answer": [
[
"1",
"2",
"3"
],
[
"A",
"B",
"C"
]
]
}
]
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the lessons.",
"tags": [
"Lessons"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/lessons/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Lessons"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/lessons/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Lessons"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/missions/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"score": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"extra_scores": {
"type": "object",
"properties": {
"score1": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"republish_count": {
"type": "string"
},
"reason_noncompliant": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"validated_date": {
"type": "string"
},
"compliant": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string"
},
"question_type": {
"type": "string"
},
"question": {
"type": "string"
},
"answer": {
"type": "array",
"items": {
"type": "string"
}
},
"page_number": {
"type": "number"
},
"question_number": {
"type": "number"
}
},
"required": [
"question_id",
"question_type",
"question",
"answer",
"page_number",
"question_number"
]
}
},
"task_number": {
"type": "number"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "finished",
"type": "mission",
"answers": [
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
"question_type": "number",
"question": "number of ice-cream flavors",
"answer": 2,
"page_number": 1,
"question_number": 1
},
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc8",
"question_type": "text",
"question": "ice-cream flavors",
"answer": [
"chocolate",
"vanilla"
],
"page_number": 1,
"question_number": 2
}
],
"task_number": 1
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "finished",
"type": "mission",
"answers": [
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
"question_type": "number",
"question": "number of ice-cream flavors",
"answer": 2,
"page_number": 1,
"question_number": 1
},
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc8",
"question_type": "text",
"question": "ice-cream flavors",
"answer": [
"chocolate",
"vanilla"
],
"page_number": 1,
"question_number": 2
}
],
"task_number": 1
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a mission for the given id.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the mission",
"required": true,
"example": "54ab03c6546847ee0d30084a",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete a mission by id.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the mission",
"required": true,
"example": "54ab03c6546847ee0d30084a",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of a mission",
"tags": [
"Missions"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the mission",
"required": true,
"example": "54ab03c6546847ee0d30084a",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"score": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string"
},
"answer": {
"type": "array",
"items": {
"type": "string"
}
},
"question_type": {
"type": "string"
},
"question": {
"type": "string"
},
"page_number": {
"type": "number"
}
},
"required": [
"answer"
]
}
}
},
"example": {
"score": {
"title": "my other score",
"value": 20
},
"answers": [
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
"answer": 3
},
{
"question_type": "text",
"question": "ice-cream flavors",
"answer": [
"chocolate",
"vanilla",
"strawberry"
],
"page_number": 1
}
]
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/tasks": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"todo": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084b",
"title": "Action plans",
"created_date": "2021-05-10T09:21:40.232Z",
"updated_date": "2021-05-10T09:21:40.232Z",
"campaign_id": "54ab03c6546847ee0d30088b",
"user_id": "5fbea9662804f40033935d9b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"todo": {
"user_id": "5fbea9662804f40033935d9b",
"tasks": [
{
"value": "TEST"
}
]
}
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084b",
"title": "Action plans",
"created_date": "2021-05-10T09:21:40.232Z",
"updated_date": "2021-05-10T09:21:40.232Z",
"campaign_id": "54ab03c6546847ee0d30088b",
"user_id": "5fbea9662804f40033935d9b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"todo": {
"user_id": "5fbea9662804f40033935d9b",
"tasks": [
{
"value": "TEST"
}
]
}
}
}
}
}
}
}
},
"summary": "Find mission's tasks",
"operationId": "Find mission's tasks",
"description": "Find the tasks for missions of type `todo`",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Replace mission's tasks",
"operationId": "Replace mission's tasks",
"description": "Update the tasks on a mission of type `todo`. \nThe `todo` object must contain *all* the tasks defined with the new values. \nOnce updated the status of the mission is set to `finished`.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/book": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
}
}
}
}
}
},
"summary": "Book",
"operationId": "Book",
"description": "Book an available mission.\n\n**Important**\nThe mission must be assigned before booking: error message: \"Mission must have an assigned user before it can be booked. Please call the assign endpoint prior to booking the mission.\"\n\nIf the mission was republished with answers during the validation of a non-compliant mission, the booked mission will contain:\n\n* `original_mission_id`\n\n* `original_reason_noncompliant`\n\n* `original_mission_answers`\n\nThe `original_mission_answers` can be used as a starting point for the answers provided to `/missions/{id}/finish`.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/unbook": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"store_id": "54ab03c6546847ee0d30081a",
"type": "mission"
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"store_id": "54ab03c6546847ee0d30081a",
"type": "mission"
}
}
}
}
}
}
},
"summary": "Unbook",
"operationId": "Unbook",
"description": "Unbook a mission.\n\nMake available a mission that was previously booked.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/assign": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "53fb03c6546847fe0d30186b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "53fb03c6546847fe0d30186b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
}
}
}
}
}
},
"summary": "Assign",
"operationId": "Assign",
"description": "Assign an available mission to a user whose `user_id` is provided.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/unassign": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"store_id": "54ab03c6546847ee0d30081a",
"status": "booked",
"type": "mission"
}
}
}
}
}
}
},
"summary": "Unassign",
"operationId": "Unassign",
"description": "Unassign a mission.\n\nMake available a mission that was previously assigned. \n**Important:**\nOnly the user that previously assigned the mission can unassign it.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/finish": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Finish",
"operationId": "Finish",
"description": "Finish a mission.\n\nThe body should only contain an `answers` field as an array.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/validate": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"validated_mission": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"status": {
"type": "string"
},
"compliant": {
"type": "boolean"
},
"validated_date": {
"type": "string"
},
"rating": {
"type": "number"
},
"republish_count": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"example": {
"validated_mission": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"finished_date": "2018-05-29T04:51:40.862Z",
"status": "finished",
"compliant": true,
"validated_date": "2018-05-30T04:51:40.862Z",
"rating": 100,
"republish_count": "3",
"type": "mission"
}
}
},
"examples": {
"response": {
"value": {
"validated_mission": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"finished_date": "2018-05-29T04:51:40.862Z",
"status": "finished",
"compliant": true,
"validated_date": "2018-05-30T04:51:40.862Z",
"rating": 100,
"republish_count": "3",
"type": "mission"
}
}
}
}
}
}
}
},
"summary": "Validate",
"operationId": "Validate",
"description": "Validate a mission.\n\n#### Fields\n\n| Field | Format | Required | Description |\n|--------------------------------|--------------|:--------:|-----------------|\n|`compliant` | boolean | x | Validated if true, rejected otherwise. |\n|`rating` | number | | Rating of the mission. |\n|`republish` | boolean | | If true, republish this mission. |\n|`republish_with_answers` | boolean | | If `republish` is true, control whether or not to prefill the republished mission with previous mission answers. |\n|`reason_noncompliant` | string | | Explanation why the mission was not compliant. |\n|`reason_noncompliant_key` | string | | Explanation key. |",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/archive": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"score": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"extra_scores": {
"type": "object",
"properties": {
"score1": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"republish_count": {
"type": "string"
},
"reason_noncompliant": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"validated_date": {
"type": "string"
},
"compliant": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"example": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "archived",
"type": "mission"
}
},
"examples": {
"response": {
"value": {
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "archived",
"type": "mission"
}
}
}
}
}
}
},
"summary": "Archive",
"operationId": "Archive",
"description": "Archive a mission.\n\nThe status of the mission will be set to `archived`.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions/{id}/workflow": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"type": {
"type": "string"
},
"booked_date": {
"type": "string"
},
"task_number": {
"type": "number"
},
"workflowState": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"step_id": {
"type": "string"
},
"step_title": {
"type": "string"
}
}
},
"workflowHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"step_id": {
"type": "string"
},
"step_title": {
"type": "string"
},
"user_id": {
"type": "string"
},
"date": {
"type": "string"
}
}
}
}
},
"example": {
"mission_id": "67726366dc8e0300a774e23d",
"title": "Field Answer Group by date field",
"created_date": "2025-01-01T09:21:40.232Z",
"updated_date": "2025-01-01T09:21:40.232Z",
"campaign_id": "6772631ddc8e0300a774e03b",
"user_id": "5fbea9662804f40033935d9b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "5b912704e64618003830c194",
"type": "mission",
"booked_date": "2024-12-30T09:10:11.225Z",
"task_number": 6,
"workflowState": {
"state": "available",
"step_id": "8cbe48e3-52b5-4ffa-bb2b-1cb51f40bf8d",
"step_title": "Step 2"
},
"workflowHistory": [
{
"state": "completed",
"step_id": "f93f7fdb-8253-4ab3-8f81-d05485c6181e",
"step_title": "Step 1",
"user_id": "5a57539eb937d8003ba3d17f",
"date": "2024-12-30T09:11:51.315Z"
}
]
}
},
"examples": {
"response": {
"value": {
"mission_id": "67726366dc8e0300a774e23d",
"title": "Field Answer Group by date field",
"created_date": "2025-01-01T09:21:40.232Z",
"updated_date": "2025-01-01T09:21:40.232Z",
"campaign_id": "6772631ddc8e0300a774e03b",
"user_id": "5fbea9662804f40033935d9b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "5b912704e64618003830c194",
"type": "mission",
"booked_date": "2024-12-30T09:10:11.225Z",
"task_number": 6,
"workflowState": {
"state": "available",
"step_id": "8cbe48e3-52b5-4ffa-bb2b-1cb51f40bf8d",
"step_title": "Step 2"
},
"workflowHistory": [
{
"state": "completed",
"step_id": "f93f7fdb-8253-4ab3-8f81-d05485c6181e",
"step_title": "Step 1",
"user_id": "5a57539eb937d8003ba3d17f",
"date": "2024-12-30T09:11:51.315Z"
}
]
}
}
}
}
}
}
},
"summary": "Find mission's workflow",
"operationId": "Find mission's workflow",
"description": "Get information about the workflow of a mission.\n\nThe `workflow_history` field is defined as an array of:\n\n| Field | Type | Description |\n|----------------------|----------------|---------------------------|\n|`state` | string | State of the step |\n|`step_id` | string | Unique id of the step |\n|`step_title` | string | The title of the step |\n|`user_id` | string | Id of the user that completed the step |\n|`date` | date | Date the user completed the step |",
"tags": [
"Missions"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/missions?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mission_id": {
"type": "string"
},
"title": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"score": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"duration": {
"type": "number"
},
"extra_scores": {
"type": "object",
"properties": {
"score1": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
}
},
"republish_count": {
"type": "string"
},
"reason_noncompliant": {
"type": "string"
},
"finished_date": {
"type": "string"
},
"validated_date": {
"type": "string"
},
"compliant": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"task_number": {
"type": "number"
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string"
},
"question_type": {
"type": "string"
},
"question": {
"type": "string"
},
"answer": {
"type": "array",
"items": {
"type": "string"
}
},
"page_number": {
"type": "number"
},
"question_number": {
"type": "number"
}
},
"required": [
"question_id",
"question_type",
"question",
"answer",
"page_number",
"question_number"
]
}
}
},
"required": [
"mission_id",
"title",
"created_date",
"updated_date",
"campaign_id",
"user_id",
"creator_id",
"store_id",
"status",
"type",
"task_number"
]
},
"example": [
{
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"duration": 2.3,
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "finished",
"type": "mission",
"task_number": 1,
"answers": [
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
"question_type": "number",
"question": "number of ice-cream flavors",
"answer": 2,
"page_number": 1,
"question_number": 1
},
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc8",
"question_type": "text",
"question": "ice-cream flavors",
"answer": [
"chocolate",
"vanilla"
],
"page_number": 1,
"question_number": 2
}
]
},
{
"mission_id": "54ab03c6546847ee0d30084b",
"title": "Rockets mission 2",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081b",
"status": "booked",
"type": "mission",
"task_number": 2
}
]
},
"examples": {
"response": {
"value": [
{
"mission_id": "54ab03c6546847ee0d30084a",
"title": "Rockets mission 1",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089a",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081a",
"score": {
"title": "my score",
"value": 10
},
"duration": 2.3,
"extra_scores": {
"score1": {
"title": "my score2",
"value": 8
}
},
"republish_count": "2",
"reason_noncompliant": "missing photo",
"finished_date": "2018-05-29T04:51:40.862Z",
"validated_date": "2018-05-30T04:51:40.862Z",
"compliant": true,
"status": "finished",
"type": "mission",
"task_number": 1,
"answers": [
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
"question_type": "number",
"question": "number of ice-cream flavors",
"answer": 2,
"page_number": 1,
"question_number": 1
},
{
"question_id": "e8335f8d-109d-475f-b10b-113ce6876dc8",
"question_type": "text",
"question": "ice-cream flavors",
"answer": [
"chocolate",
"vanilla"
],
"page_number": 1,
"question_number": 2
}
]
},
{
"mission_id": "54ab03c6546847ee0d30084b",
"title": "Rockets mission 2",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"campaign_id": "54ab03c6546847ee0d30088a",
"user_id": "54ab03c6546847ee0d30089b",
"creator_id": "54ab03c6546847ee0d30089a",
"store_id": "54ab03c6546847ee0d30081b",
"status": "booked",
"type": "mission",
"task_number": 2
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the missions.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object.\nOptionally add the answers to the result if exist.\n",
"required": false,
"example": "{ include: [\"answers\"] }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/missions/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Missions"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/missions/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Missions"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/missions/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.\n\n**Important:**\n\n- Rows without an existing `mission_id` field will **not** be processed. Only existing missions may be updated by this import endpoint.\n\n- Only the following fields can be modified via a mission import: \n - title \n - score (the numeric score value, e.g. `10` — the score column holds the value, not the `{title, value}` object) \n - group_ids \n - user_ids\n\n `extra_scores` is export-only: sub-scores appear as separate (translated) columns and are not read back on import.\n\n For any other change, please refer to the corresponding endpoint.\n\n### Fields\n\n| Field | Format | Required | Readonly | Description |\n|--------------------------------|--------------|:--------:|:--------:|-----------------|\n|`mission_id` | string | x | x | Unique id of the mission |\n|`title` | string | | | The title of the mission |\n|`type` | string | | x | Mission type |\n|`campaign_id` | string | | x | Unique id of the mission's parent campaign |\n|`user_id` | string | | x | Unique id of the user who performs the mission |\n|`creator_id` | string | | x | Unique id of the mission creator |\n|`store_id` | string | | x | Unique id of associated store |\n|`status` | string | | x | Current status of the mission if set: `\"scheduled\"`, `\"booked\"`, `\"finished\"`, `\"archived\"` |\n|`valid_from` | timestamp | | x | Mission available from |\n|`republish_count` | number | | x | The number of times the mission was republished |\n|`booked_date` | timestamp | | x | The date on which the mission was booked to a user |\n|`due_date` | timestamp | | x | The date by which the mission must be completed |\n|`finished_date` | timestamp | | x | The date on which the mission was finished |\n|`score` | number | | | The mission's main score as its numeric value (e.g. `10`). In file exports/imports this column holds the score value only; the full `{\"title\", \"value\"}` object is used in the JSON API representation. |\n|`extra_scores` | number | | x | Export only. Each sub-score is written to its own column, named after the (translated) sub-score title and holding that sub-score's numeric value. It cannot be set via import. |\n|`compliant` | boolean | | x | The compliance of the mission as marked by an area manager: `true` if marked compliant, `false` if marked noncompliant. If nothing is specified and if the mission is finished, `status` will be \"to validate\" |\n|`compliant_by_default` | boolean | | x | If `true` the mission is automatically marked compliant on finish |\n|`validated_date` | timestamp | | x | The date on which the mission was validated |\n|`reason_noncompliant` | string | | x | The reason provided by the area manager to explain why the mission was marked noncompliant |\n|`republished_with_answers` | boolean | | x | Has the mission been repulished with the previous answers after being marked noncompliant |\n|`original_mission_id` | string | | x | If present, the `mission_id` of the mission that this mission was republished from |\n|`original_reason_noncompliant` | string | | x | The `reason_noncompliant` from the original mission that was republished. |\n|`action_plan_progress` | number | | x | Completion rate of an action plan. |\n|`task_number` | number | | x | Auto generated when a new mission is created. The value is unique within a campaign. |\n|`created_date` | timestamp | | x | Mission's creation date |\n|`updated_date` | timestamp | | x | Mission's last update date |",
"tags": [
"Missions"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/mission-comments/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a comment for the given id.",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the comment",
"required": true,
"example": "5d31ecba11e695003a9b1dfc",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete a mission comment by id.",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the comment",
"required": true,
"example": "5d31ecba11e695003a9b1dfc",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of a mission comment",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the comment",
"required": true,
"example": "5d31ecba11e695003a9b1dfc",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"photo_url": {
"type": "string"
}
},
"example": {
"photo_url": "https://assets-dev.yoobic.com/image/upload/v1675350130/development/nyjwh5zmbnjxdwtsqfyz.jpg"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/mission-comments?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the mission-comments.",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/mission-comments/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/mission-comments": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single mission comment or multiple mission comments using this action.\nWhen creating a single mission comment, the body contains a json object, when creating multiple mission comments, the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"mission_id": {
"type": "string"
},
"text": {
"type": "string"
}
},
"example": {
"user_id": "5beee5197fc4d50043801bd1",
"mission_id": "5d31b71a1a76e9003afd621e",
"text": "Life is beautiful!"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/mission-comments/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/mission-comments/import?type={type}": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Import file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Import",
"operationId": "Import",
"description": "See the [Import file section](#section-import-jobs) for more information.",
"tags": [
"Mission Comments"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "Content-Disposition",
"in": "header",
"description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"",
"required": false,
"example": "form-data; name=\"file\"; filename=\"file.csv\"",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImportBody"
}
}
},
"/public/api/news/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"news_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"user_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"authorised_viewers": {
"type": "number"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"news_id": "54ab03c6546847ee0d30083e",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
},
"examples": {
"response": {
"value": {
"news_id": "54ab03c6546847ee0d30083e",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get news for the given id.",
"tags": [
"News"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the news",
"required": true,
"example": "54ab03c6546847ee0d30083e",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"summary": "Delete",
"operationId": "Delete",
"description": "Delete a news object by id.",
"tags": [
"News"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the news",
"required": true,
"example": "54ab03c6546847ee0d30083e",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"news_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"user_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"authorised_viewers": {
"type": "number"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"news_id": "54ab03c6546847ee0d30081a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd incoming news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
},
"examples": {
"response": {
"value": {
"news_id": "54ab03c6546847ee0d30081a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd incoming news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
}
}
}
}
}
},
"summary": "Partial Update",
"operationId": "Partial Update",
"description": "Update a subset of properties of a news object",
"tags": [
"News"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the news",
"required": true,
"example": "54ab03c6546847ee0d30083e",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"description": "The id of the news",
"required": true,
"example": "54ab03c6546847ee0d30081a",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/news?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"news_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"user_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"views": {
"type": "number"
},
"likes": {
"type": "number"
},
"authorised_viewers": {
"type": "number"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"news_id",
"updated_date",
"created_date",
"user_id",
"title",
"description",
"views",
"likes",
"authorised_viewers",
"images",
"group_ids"
]
},
"example": [
{
"news_id": "54ab03c6546847ee0d30081a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
},
{
"news_id": "54ab03c6546847ee0d30081c",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news 3",
"description": "Contents of the feed.",
"views": 1,
"likes": 12,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile2.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
]
},
"examples": {
"response": {
"value": [
{
"news_id": "54ab03c6546847ee0d30081a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news",
"description": "Contents of the feed.",
"views": 3,
"likes": 10,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
},
{
"news_id": "54ab03c6546847ee0d30081c",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd news 3",
"description": "Contents of the feed.",
"views": 1,
"likes": 12,
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile2.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
]
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the news.",
"tags": [
"News"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/news/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"News"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/news": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"news_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"user_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"authorised_viewers": {
"type": "number"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"news_id": "54ab03c6546847ee0d30081a",
"updated_date": "2020-09-14T04:51:40.862Z",
"created_date": "2020-09-14T04:51:40.862Z",
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd exciting news",
"description": "News content",
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
],
"tags": [
"rockets_stars",
"rockets_fans"
]
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single or multiple news using this action.\nWhen creating a single news object the body contains a json object, when creating multiple news objects the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"News"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"authorised_viewers": {
"type": "number"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"user_id": "54ab03c6546847ee0d30072b",
"title": "Rocket ltd exciting news",
"description": "News content",
"authorised_viewers": 100,
"images": [
"www.rocketltd.com/file/RocketsFile1.jpg"
],
"group_ids": [
"rockets_hq",
"rockets_pr",
"rockets_employees"
],
"tags": [
"rockets_stars",
"rockets_fans"
]
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/news/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"News"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/notifications/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"notification_id": {
"type": "string"
},
"title": {
"type": "string"
},
"mode": {
"type": "string"
},
"sender_id": {
"type": "string"
},
"push_recipients": {
"type": "number"
},
"entity_type": {
"type": "string"
},
"entity_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"example": {
"notification_id": "54ab03c6546847ee0d30081d",
"title": "Rocket ltd notification 1",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": 3,
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
}
},
"examples": {
"response": {
"value": {
"notification_id": "54ab03c6546847ee0d30081d",
"title": "Rocket ltd notification 1",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": 3,
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a notification for the given id.",
"tags": [
"Notifications"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the notification",
"required": true,
"example": "54ab03c6546847ee0d30083e",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/notifications?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"notification_id": {
"type": "string"
},
"title": {
"type": "string"
},
"mode": {
"type": "string"
},
"sender_id": {
"type": "string"
},
"push_recipients": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"entity_type": {
"type": "string"
},
"entity_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
}
},
"required": [
"notification_id",
"title",
"mode",
"sender_id",
"push_recipients",
"entity_type",
"entity_id",
"updated_date",
"created_date"
]
},
"example": [
{
"notification_id": "54ab03c6546847ee0d30081d",
"title": "Rocket ltd notification 1",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": 3,
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
},
{
"notification_id": "54ab03c6546847ee0d30081e",
"title": "Rocket ltd notification 2",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": "1",
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
}
]
},
"examples": {
"response": {
"value": [
{
"notification_id": "54ab03c6546847ee0d30081d",
"title": "Rocket ltd notification 1",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": 3,
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
},
{
"notification_id": "54ab03c6546847ee0d30081e",
"title": "Rocket ltd notification 2",
"mode": "notification",
"sender_id": "54ab03c6546847ee0d30072b",
"push_recipients": "1",
"entity_type": "Mission",
"entity_id": "54ab03c6546847ee0d30072a",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z"
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the notifications.",
"tags": [
"Notifications"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/notifications": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Create",
"operationId": "Create",
"description": "You may create a new single notification or multiple notifications using this action. \nWhen creating a single notification the body contains a json object, when creating multiple notifications the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**",
"tags": [
"Notifications"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"mode": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"entity_id": {
"type": "string"
}
},
"example": {
"user_ids": [
"5babb8a69fa6ae919f675715",
"5babb8a69fa6ae919f675716"
],
"group_ids": [
"company_employees"
],
"title": "Major news",
"body": "New deal signed with ...",
"mode": "push",
"entity_type": "news",
"entity_id": "54ab03c6546847ee0d30084a"
}
}
}
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/notifications/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Notifications"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/notifications/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Notifications"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/photos/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"photo_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"mission_id": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"mission_data_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"markup_url": {
"type": "string"
},
"question_id": {
"type": "string"
},
"phash": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"short_desc": {
"type": "string"
},
"entity_id": {
"type": "string"
}
},
"example": {
"photo_id": "54ab03c6546847ee0d30081d",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 1",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"markup_url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidg.jpg",
"question_id": "54ab03c6546847ee0d30072b",
"phash": "12a34b6cd6cb2134",
"tags": [
"OK"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072a"
}
},
"examples": {
"response": {
"value": {
"photo_id": "54ab03c6546847ee0d30081d",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 1",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"markup_url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidg.jpg",
"question_id": "54ab03c6546847ee0d30072b",
"phash": "12a34b6cd6cb2134",
"tags": [
"OK"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072a"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a photo for the given id.",
"tags": [
"Photos"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the photo",
"required": true,
"example": "54ab03c6546847ee0d30081d",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/photos": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"photo_id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"photo_id": "5dc14612234f047cfe100a09",
"title": "Shelf No. 1",
"url": "https://res.cloudinary.com/www-yoobic-com/image/upload/v1572947475/qyrpyiscrd28s4hbrxqm.jpg",
"created_date": "2019-11-05T09:51:14.937Z",
"updated_date": "2019-11-05T09:51:14.937Z"
}
},
"examples": {
"response": {
"value": {
"photo_id": "5dc14612234f047cfe100a09",
"title": "Shelf No. 1",
"url": "https://res.cloudinary.com/www-yoobic-com/image/upload/v1572947475/qyrpyiscrd28s4hbrxqm.jpg",
"created_date": "2019-11-05T09:51:14.937Z",
"updated_date": "2019-11-05T09:51:14.937Z"
}
}
}
}
}
}
},
"summary": "Create",
"operationId": "Create",
"description": "Upload a photo.\n\nTo upload a photo, you should make a post request of type `multipart/form-data`.\nThe request body should contain two fields:\n\n`file`: the binary image file you want to upload.\n`title`: give a title to the photo.",
"tags": [
"Photos"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/photos?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"photo_id": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"created_date": {
"type": "string"
},
"mission_id": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"mission_data_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"markup_url": {
"type": "string"
},
"question_id": {
"type": "string"
},
"phash": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"short_desc": {
"type": "string"
},
"entity_id": {
"type": "string"
}
},
"required": [
"photo_id",
"updated_date",
"created_date",
"mission_id",
"campaign_id",
"mission_data_id",
"store_id",
"title",
"url",
"question_id",
"phash",
"tags",
"short_desc",
"entity_id"
]
},
"example": [
{
"photo_id": "54ab03c6546847ee0d30081d",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 1",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"markup_url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"question_id": "54ab03c6546847ee0d30072b",
"phash": "12a34b6cd6cb2134",
"tags": [
"OK"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072a"
},
{
"photo_id": "54ab03c6546847ee0d30081e",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 2",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"question_id": "54ab03c6546847ee0d30072c",
"phash": "12a34b6cd6cb2134",
"tags": [
"No"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072b"
}
]
},
"examples": {
"response": {
"value": [
{
"photo_id": "54ab03c6546847ee0d30081d",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 1",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"markup_url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"question_id": "54ab03c6546847ee0d30072b",
"phash": "12a34b6cd6cb2134",
"tags": [
"OK"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072a"
},
{
"photo_id": "54ab03c6546847ee0d30081e",
"updated_date": "2018-05-23T04:51:40.862Z",
"created_date": "2018-05-23T04:51:40.862Z",
"mission_id": "54ab03c6546847ee0d30081c",
"campaign_id": "54ab03c6546847ee0d30077a",
"mission_data_id": "54ab03c6546847ee0d300790",
"store_id": "54ab03c6546847ee0d30076a",
"title": "Rocket ltd photo 2",
"url": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"question_id": "54ab03c6546847ee0d30072c",
"phash": "12a34b6cd6cb2134",
"tags": [
"No"
],
"short_desc": "Mission",
"entity_id": "54ab03c6546847ee0d30072b"
}
]
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the photos.",
"tags": [
"Photos"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/photos/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Photos"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/photos/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Photos"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/plans/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"example": {
"plan_id": "5c015012ad45490041a52f64",
"title": "QA - Document",
"description": "Course to test Documents Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
},
"examples": {
"response": {
"value": {
"plan_id": "5c015012ad45490041a52f64",
"title": "QA - Document",
"description": "Course to test Documents Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
}
}
}
}
}
}
},
"summary": "Get",
"operationId": "Get",
"description": "Get a plan for the given id.",
"tags": [
"Plans"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the plan",
"required": true,
"example": "5c015012ad45490041a52f64",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/plans/{id}/assign": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"5e4514ac98ab7400553bf15f",
"5e4514ac98ab7400553bf160"
]
},
"examples": {
"response": {
"value": [
"5e4514ac98ab7400553bf15f",
"5e4514ac98ab7400553bf160"
]
}
}
}
}
}
},
"summary": "Assign",
"operationId": "Assign",
"description": "Assign a plan to users. Response is an array of courses ids created for each assigned user.",
"tags": [
"Plans"
],
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": []
}
]
}
},
"/public/api/plans?filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"paging": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"skip": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"tenant": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
}
},
"required": [
"plan_id",
"title",
"description",
"tenant",
"created_date",
"updated_date"
]
}
}
},
"example": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"plan_id": "5c015012ad45490041a52f64",
"title": "QA - Document",
"description": "Course to test Documents Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
},
{
"plan_id": "5c015558ad45490041a53473",
"title": "QA - Video",
"description": "Course to test Video Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T15:20:56.392Z",
"updated_date": "2019-01-25T13:34:05.098Z"
}
]
}
},
"examples": {
"response": {
"value": {
"paging": {
"total": 2,
"skip": 0,
"limit": 1000
},
"data": [
{
"plan_id": "5c015012ad45490041a52f64",
"title": "QA - Document",
"description": "Course to test Documents Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T14:58:26.716Z",
"updated_date": "2019-01-25T13:34:14.819Z"
},
{
"plan_id": "5c015558ad45490041a53473",
"title": "QA - Video",
"description": "Course to test Video Lessons",
"tenant": "qa_boost",
"created_date": "2018-11-30T15:20:56.392Z",
"updated_date": "2019-01-25T13:34:05.098Z"
}
]
}
}
}
}
}
}
},
"summary": "Get All",
"operationId": "Get All",
"description": "Get all the plans.",
"tags": [
"Plans"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/plans/count?where={where}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"example": {
"count": 10
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
}
},
"summary": "Count",
"operationId": "Count",
"description": "Count all the existing entities based on the where filter",
"tags": [
"Plans"
],
"parameters": [
{
"name": "where",
"in": "query",
"description": "A valid JSON [Where filter](#section-api-requests-filter-where)",
"required": false,
"example": "{ \"property\": \"value\" }",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/plans/export?type={type}&filter={filter}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"priority": {
"type": "number"
},
"nextRunAt": {
"type": "string"
},
"_id": {
"type": "string"
}
},
"example": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
},
"examples": {
"response": {
"value": {
"name": "Export file",
"type": "normal",
"priority": 0,
"nextRunAt": "2018-09-11T15:56:05.387Z",
"_id": "5b97e5954b99568b4b9101af"
}
}
}
}
}
}
},
"summary": "Export",
"operationId": "Export",
"description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.",
"tags": [
"Plans"
],
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of file, either `csv` (default value) or `excel`",
"required": true,
"example": "csv",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "A valid JSON filter object (does not accept a `fields` filter)",
"required": false,
"example": "{}",
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "e.g. application/json",
"required": false,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Get_AllBody"
}
}
},
"/public/api/products/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"created_date": {
"type": "string"
},
"updated_date": {
"type": "string"
},
"title": {
"type": "string"
},
"price": {
"type": "number"
},
"reference": {
"type": "string"
},
"image": {
"type": "string"
},
"short_desc": {
"type": "string"
},
"out_of_stock": {
"type": "boolean"
},
"description": {
"type": "string"
},
"catalog_id": {
"type": "string"
},
"catalog_title": {
"type": "string"
}
},
"example": {
"product_id": "54ab03c6546847ee0d30081d",
"created_date": "2018-05-23T04:51:40.862Z",
"updated_date": "2018-05-23T04:51:40.862Z",
"title": "Rocket ltd product 1",
"price": 20.4,
"reference": "Rocket ltd SKU 1",
"image": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg",
"short_desc": "Rocket
", "out_of_stock": false, "description": "Great rocket example
", "catalog_id": "54ab03c6546847ee0d30076b", "catalog_title": "Rockets Catalog" } }, "examples": { "response": { "value": { "product_id": "54ab03c6546847ee0d30081d", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-05-23T04:51:40.862Z", "title": "Rocket ltd product 1", "price": 20.4, "reference": "Rocket ltd SKU 1", "image": "https://res.cloudinary.com/yoobic/image/upload/v1475779283/r4b1ticoyezzkdubkidf.jpg", "short_desc": "Rocket
", "out_of_stock": false, "description": "Great rocket example
", "catalog_id": "54ab03c6546847ee0d30076b", "catalog_title": "Rockets Catalog" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a product for the given id.", "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the product", "required": true, "example": "54ab03c6546847ee0d30081d", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/products?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Get All", "operationId": "Get All", "description": "Get all the products.", "tags": [ "Products" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/products/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Products" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/products/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Products" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/products/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import", "operationId": "Import", "description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Type | Required | Description |\n|----------------------|:--------------:|:--------:|---------------------------|\n|`product_id` | string | | Unique id of the product |\n|`title` | string | x | The product title |\n|`price` | number | | The product price |\n|`reference` | string | x | The product reference (SKU) |\n|`image` | string | | The url to the image |\n|`short_desc` | string | | Short description of the product |\n|`description` | string | | Description of the product |\n|`catalog_id` | string | x | Unique id of the catalog |\n|`catalog_title` | string | x | Title of the catalog |\n|`tags` | array | | Tags of the product in the form \"aaa,bbb\" - multiple tags are comma separated |\n|`manufacturer` | string | | The manufacturer name of the product | \n|`brand` | string | | The brand name of the product | \n|`category` | string | | The category name of the product | \n|`images` | array | | The image urls associated with this product - multiple images are comma separated | \n|`out_of_stock` | boolean | | Whether or not product is available | \n|`created_date` | date | | Creation date |\n|`updated_date` | date | | Last update date |\n\nOne of either fields is required:\n\n- catalog_id\n\n- catalog_title\n\n**important**: \nIf you are using custom_fields, you can also add columns corresponding to the name of each of your custom_fields in your import file", "tags": [ "Products" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/questions/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "question_id": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "is_wiki": { "type": "boolean" }, "likes": { "type": "number" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "question_id": "634925735aa7ab001df22cda", "title": "new article test", "user_id": "63482186d676de001d29288b", "is_wiki": true, "likes": 1, "created_date": "2022-10-14T09:01:39.744Z", "updated_date": "2022-10-18T09:33:29.552Z" } }, "examples": { "response": { "value": { "question_id": "634925735aa7ab001df22cda", "title": "new article test", "user_id": "63482186d676de001d29288b", "is_wiki": true, "likes": 1, "created_date": "2022-10-14T09:01:39.744Z", "updated_date": "2022-10-18T09:33:29.552Z" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a question for the given id.", "tags": [ "Questions" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the question", "required": true, "example": "61b9b435c8f864003a552378", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/questions?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Get All", "operationId": "Get All", "description": "Get all the questions.", "tags": [ "Questions" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/questions/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Questions" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/questions/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Questions" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/acl-roles/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "acl_role_id": { "type": "string" }, "client_role": { "type": "string" }, "client_role_extension": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "acl_role_id": "635fa9a8fffb8783206ea224", "client_role": "ROLESTORE", "client_role_extension": "test", "created_date": "2022-10-31T10:55:36.857Z", "updated_date": "2022-10-31T10:55:36.857Z" } }, "examples": { "response": { "value": { "acl_role_id": "635fa9a8fffb8783206ea224", "client_role": "ROLESTORE", "client_role_extension": "test", "created_date": "2022-10-31T10:55:36.857Z", "updated_date": "2022-10-31T10:55:36.857Z" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a role for the given id.", "tags": [ "Roles" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the role", "required": true, "example": "635fa9a8fffb8783206ea224", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/acl-roles?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "acl_role_id": { "type": "string" }, "client_role": { "type": "string" }, "client_role_extension": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "acl_role_id", "client_role", "created_date", "updated_date" ] }, "example": [ { "acl_role_id": "5f591f87933fa329c5956d7d", "client_role": "ROLESTORE", "client_role_extension": "Tudor", "created_date": "2020-09-09T18:31:35.542Z", "updated_date": "2022-10-31T10:54:27.973Z" }, { "acl_role_id": "61538d4de9967a003670703c", "client_role": "ROLEVIEWER", "created_date": "2021-09-28T21:46:53.325Z", "updated_date": "2022-10-28T21:01:37.131Z" } ] }, "examples": { "response": { "value": [ { "acl_role_id": "5f591f87933fa329c5956d7d", "client_role": "ROLESTORE", "client_role_extension": "Tudor", "created_date": "2020-09-09T18:31:35.542Z", "updated_date": "2022-10-31T10:54:27.973Z" }, { "acl_role_id": "61538d4de9967a003670703c", "client_role": "ROLEVIEWER", "created_date": "2021-09-28T21:46:53.325Z", "updated_date": "2022-10-28T21:01:37.131Z" } ] } } } } } }, "summary": "Get All", "operationId": "Get All", "description": "Get all the roles.", "tags": [ "Roles" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/acl-roles/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Roles" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/acl-roles/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Roles" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/shifts/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "shift_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "user_id": { "type": "string" }, "store_id": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "client_id": { "type": "string" }, "username": { "type": "string" } }, "example": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } }, "examples": { "response": { "value": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a shift for the given id", "tags": [ "Shifts" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the shifts", "required": true, "example": "5efd1157b2e93c96bc8ea071", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "shift_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "user_id": { "type": "string" }, "store_id": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "client_id": { "type": "string" }, "username": { "type": "string" } }, "example": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } }, "examples": { "response": { "value": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } } } } } } }, "summary": "Create", "operationId": "Create", "description": "Creating a single shifts", "tags": [ "Shifts" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the shifts", "required": true, "example": "5efd1157b2e93c96bc8ea071", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "username": { "type": "string" } }, "example": { "client_id": "VT008", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "username": "newgeofilter1" } } } } }, "security": [ { "oauth2": [] } ] }, "patch": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "shift_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "user_id": { "type": "string" }, "store_id": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "client_id": { "type": "string" }, "username": { "type": "string" } }, "example": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "updated description", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } }, "examples": { "response": { "value": { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "updated description", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" } } } } } } }, "summary": "Partial Update", "operationId": "Partial Update", "description": "Update a subset of properties of a shift", "tags": [ "Shifts" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the shifts", "required": true, "example": "5efd1157b2e93c96bc8ea071", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/shifts?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shift_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "user_id": { "type": "string" }, "store_id": { "type": "string" }, "tenant": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "client_id": { "type": "string" }, "username": { "type": "string" } }, "required": [ "shift_id", "title", "description", "start_date", "end_date", "user_id", "store_id", "tenant", "created_date", "updated_date", "client_id", "username" ] }, "example": [ { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "tenant": "vitaltest", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" }, { "shift_id": "63d1289f955423001dde00fc", "title": "New shift8", "description": "10:00 - 16:00", "start_date": "2022-12-18T09:00:00.000Z", "end_date": "2022-12-18T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "tenant": "vitaltest", "created_date": "2023-01-25T13:03:27.676Z", "updated_date": "2023-01-25T13:03:27.676Z", "client_id": "VT008", "username": "newgeofilter1" } ] }, "examples": { "response": { "value": [ { "shift_id": "63dbe3f3fb2603001d1f958c", "title": "New shift4", "description": "10:00 - 16:00", "start_date": "2022-12-14T09:00:00.000Z", "end_date": "2022-12-14T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "tenant": "vitaltest", "created_date": "2023-02-02T16:25:23.119Z", "updated_date": "2023-02-02T16:25:23.119Z", "client_id": "VT008", "username": "newgeofilter1" }, { "shift_id": "63d1289f955423001dde00fc", "title": "New shift8", "description": "10:00 - 16:00", "start_date": "2022-12-18T09:00:00.000Z", "end_date": "2022-12-18T16:00:00.000Z", "user_id": "62c2adf1e926980025f9986f", "store_id": "5f3e4cc1fe89be003bc29bd6", "tenant": "vitaltest", "created_date": "2023-01-25T13:03:27.676Z", "updated_date": "2023-01-25T13:03:27.676Z", "client_id": "VT008", "username": "newgeofilter1" } ] } } } } } }, "summary": "Get All", "operationId": "Get All", "description": "Get all the shifts.", "tags": [ "Shifts" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/shifts/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Shifts" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/shifts/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Shifts" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/shifts/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import", "operationId": "Import", "description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n| shift_id | string | x | The unique identifier of the shift. |\n| username | string | x | The unique username of the employee assigned to the shift. |\n| user_id | string | | An external identifier for the employee |\n| title | string | x | The title of the shift. (visible in the calendar of the user) |\n| store_id | string | | An external identifier for the employee |\n| start_date | string | x | The start date and time of the shift. |\n| end_date | string | x | The end date and time of the shift. |\n| description | string | | The description of the shift. |\n| client_id | string | x | The unique client_id of the location where the shift takes place. |\n| _lmt | string | | The last modified time of the shift. |\n| _ect | string | | The time when the shift was created. |", "tags": [ "Shifts" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/store-types/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "store_type_id": { "type": "string" }, "name": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } }, "examples": { "response": { "value": { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a store type for the given id.", "tags": [ "Store Types" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "delete": { "responses": { "204": { "description": "No Content", "headers": {} } }, "summary": "Delete", "operationId": "Delete", "description": "Delete a store type by id.", "tags": [ "Store Types" ], "security": [ { "oauth2": [] } ] }, "patch": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "store_type_id": { "type": "string" }, "name": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } }, "examples": { "response": { "value": { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } } } } } } }, "summary": "Partial Update", "operationId": "Partial Update", "description": "Update a subset of properties of a store type", "tags": [ "Store Types" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "ice-cream" } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/store-types?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "number" }, "skip": { "type": "number" }, "limit": { "type": "number" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "store_type_id": { "type": "string" }, "name": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "store_type_id", "name", "group_ids", "created_date", "updated_date" ] } } }, "example": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" }, { "store_type_id": "56b0c262e9a22a4e5f02be7e", "name": "fruit", "group_ids": [ "staf", "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } ] } }, "examples": { "response": { "value": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" }, { "store_type_id": "56b0c262e9a22a4e5f02be7e", "name": "fruit", "group_ids": [ "staf", "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } ] } } } } } } }, "summary": "Get all", "operationId": "Get all", "description": "Get all stores.", "tags": [ "Store Types" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/store-types/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Store Types" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/store-types": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "store_type_id": { "type": "string" }, "name": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "store_type_id", "name", "group_ids", "created_date", "updated_date" ] }, "example": [ { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" }, { "store_type_id": "56b0c262e9a22a4e5f02be7e", "name": "fruit", "group_ids": [ "managers", "staf" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } ] }, "examples": { "response": { "value": [ { "store_type_id": "56b0c262e9a22a4e5f02be7d", "name": "ice-cream", "group_ids": [ "managers" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" }, { "store_type_id": "56b0c262e9a22a4e5f02be7e", "name": "fruit", "group_ids": [ "managers", "staf" ], "created_date": "2016-02-02T14:51:14.644Z", "updated_date": "2016-07-15T14:18:41.750Z" } ] } } } } } }, "summary": "Create", "operationId": "Create", "description": "You may create a new single store type or multiple store types using this action.\nWhen creating a single store type, the body contains a json object, when creating multiple store types, the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**", "tags": [ "Store Types" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } } }, "example": { "name": "ice-cream", "group_ids": [ "managers" ] } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/store-types/export?{filter}&type={type}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Store Types" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/store-types/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import", "operationId": "Import", "description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|------------------|\n|`store_type_id` | string | | Unique store type id |\n|`name` | string | x | Name of the store type|\n|`group_ids` | array | x | Group ids that can see this store type|", "tags": [ "Store Types" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/stores/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "store_id": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "contact_email": { "type": "string" }, "contact_phone": { "type": "string" }, "contact_name": { "type": "string" }, "notification_emails": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" }, "timezone": { "type": "string" }, "vip": { "type": "boolean" }, "properties": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "isPercent": { "type": "boolean" }, "colorHex": { "type": "string" } }, "required": [ "title", "value", "colorHex", "isPercent" ] } } } } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "vip": true, "properties": [ { "title": "KPI S27", "type": "columns", "values": [ { "title": "Revenues", "value": "1 456 $", "isPercent": false, "colorHex": "#00FF00" }, { "title": "Nb Hours", "value": "7/66", "colorHex": "#B404FF" }, { "title": "QP", "value": 2.8, "isPercent": true, "colorHex": "#B40404" } ] } ], "created_date": "2018-05-24T04:51:40.862Z", "updated_date": "2018-05-24T04:51:40.862Z" } }, "examples": { "response": { "value": { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "vip": true, "properties": [ { "title": "KPI S27", "type": "columns", "values": [ { "title": "Revenues", "value": "1 456 $", "isPercent": false, "colorHex": "#00FF00" }, { "title": "Nb Hours", "value": "7/66", "colorHex": "#B404FF" }, { "title": "QP", "value": 2.8, "isPercent": true, "colorHex": "#B40404" } ] } ], "created_date": "2018-05-24T04:51:40.862Z", "updated_date": "2018-05-24T04:51:40.862Z" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a store for the given id.", "tags": [ "Stores" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "patch": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "store_id": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "contact_email": { "type": "string" }, "contact_phone": { "type": "string" }, "contact_name": { "type": "string" }, "notification_emails": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" }, "timezone": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } }, "examples": { "response": { "value": { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } } } } } } }, "summary": "Partial Update", "operationId": "Partial Update", "description": "Update a subset of properties of a store", "tags": [ "Stores" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "example": { "tags": [ "ICE ICE BABY" ] } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/stores/{id}/health-score?days{days}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "healthscore": { "type": "object", "properties": { "today": { "type": "number" }, "yesterday": { "type": "number" } } }, "reactivity": { "type": "object", "properties": { "today": { "type": "number" }, "yesterday": { "type": "number" } } }, "compliance": { "type": "object", "properties": { "today": { "type": "number" }, "yesterday": { "type": "number" } } }, "accuracy": { "type": "object", "properties": { "today": { "type": "number" }, "yesterday": { "type": "number" } } }, "review": { "type": "object", "properties": { "today": { "type": "number" }, "yesterday": { "type": "number" } } }, "evolution": { "type": "object", "properties": { "lowest": { "type": "number" }, "highest": { "type": "number" }, "evolution": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "required": [ "date", "value" ] } }, "current": { "type": "number" } } } }, "example": { "healthscore": { "today": 28, "yesterday": 28 }, "reactivity": { "today": 31, "yesterday": 31 }, "compliance": { "today": 9, "yesterday": 9 }, "accuracy": { "today": 38, "yesterday": 38 }, "review": { "today": 32, "yesterday": 32 }, "evolution": { "lowest": 25, "highest": 30, "evolution": [ { "date": "2019-02-24T03:08:35.501Z", "value": 28 }, { "date": "2019-02-23T03:08:09.680Z", "value": 28 }, { "date": "2019-02-22T03:08:19.140Z", "value": 28 }, { "date": "2019-02-21T03:15:25.134Z", "value": 29 }, { "date": "2019-02-20T03:14:16.949Z", "value": 27 }, { "date": "2019-02-19T03:09:00.727Z", "value": 25 }, { "date": "2019-02-18T03:09:59.539Z", "value": 30 }, { "date": "2019-02-17T03:08:11.926Z", "value": 28 }, { "date": "2019-02-16T03:14:42.549Z", "value": 28 } ], "current": 28 } } }, "examples": { "response": { "value": { "healthscore": { "today": 28, "yesterday": 28 }, "reactivity": { "today": 31, "yesterday": 31 }, "compliance": { "today": 9, "yesterday": 9 }, "accuracy": { "today": 38, "yesterday": 38 }, "review": { "today": 32, "yesterday": 32 }, "evolution": { "lowest": 25, "highest": 30, "evolution": [ { "date": "2019-02-24T03:08:35.501Z", "value": 28 }, { "date": "2019-02-23T03:08:09.680Z", "value": 28 }, { "date": "2019-02-22T03:08:19.140Z", "value": 28 }, { "date": "2019-02-21T03:15:25.134Z", "value": 29 }, { "date": "2019-02-20T03:14:16.949Z", "value": 27 }, { "date": "2019-02-19T03:09:00.727Z", "value": 25 }, { "date": "2019-02-18T03:09:59.539Z", "value": 30 }, { "date": "2019-02-17T03:08:11.926Z", "value": 28 }, { "date": "2019-02-16T03:14:42.549Z", "value": 28 } ], "current": 28 } } } } } } } }, "summary": "Health Score of a store API", "operationId": "Health Score of a store API", "description": "An in house KPI to help measure a store's condition.\nThe Health Score is determined according to 4 criteria:\n\n- `reactivity`: Percentage of completed missions on time.\n\n- `accuracy`: Percentage of compliant missions.\n\n- `compliance`: Percentage of compliant campaigns. Campaign compliancy is set when the last mission on the store is compliant.\n\n- `review`: This concept aims to integrate audits completed by managers over the store in the Health Score\n\nThe final score is then given with two additional parameters:\n\n- `healthscore`: Is the final grade calculated according to the average of the 4 criteria above.\n\n- `evolution`: This is the history of the store's `healthscore` (determined by the `days` parameter and defaults to `7`).", "tags": [ "Stores" ], "parameters": [ { "name": "days", "in": "query", "description": "The number of days back to calculate the healthscore (defaults to 7)", "required": false, "example": "7", "schema": { "type": "number" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/stores/{id}/archive": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string" } }, "example": { "result": "success" } }, "examples": { "response": { "value": { "result": "success" } } } } } } }, "summary": "Archive", "operationId": "Archive", "description": "Archive a store", "tags": [ "Stores" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/stores/{id}/unarchive": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string" } }, "example": { "result": "success" } }, "examples": { "response": { "value": { "result": "success" } } } } } } }, "summary": "Unarchive", "operationId": "Unarchive", "description": "Restore an archived store.", "tags": [ "Stores" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/stores?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "number" }, "skip": { "type": "number" }, "limit": { "type": "number" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "store_id": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "contact_email": { "type": "string" }, "contact_phone": { "type": "string" }, "contact_name": { "type": "string" }, "notification_emails": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" }, "timezone": { "type": "string" }, "capacity": { "type": "number" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "store_id", "title", "address", "tags", "client_id", "store_type_name", "latitude", "longitude", "contact_email", "contact_phone", "contact_name", "notification_emails", "country", "timezone", "created_date", "updated_date" ] } } }, "example": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "capacity": 100, "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acae2", "title": "ice-cream-store-2", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "008", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store2.com", "contact_phone": "1800-008-008", "contact_name": "jane", "notification_emails": [ "james@store2.com", "jane@store2.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } ] } }, "examples": { "response": { "value": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "capacity": 100, "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acae2", "title": "ice-cream-store-2", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "008", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store2.com", "contact_phone": "1800-008-008", "contact_name": "jane", "notification_emails": [ "james@store2.com", "jane@store2.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } ] } } } } } } }, "summary": "Get all", "operationId": "Get all", "description": "Get all stores.", "tags": [ "Stores" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/stores/archives?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "number" }, "skip": { "type": "number" }, "limit": { "type": "number" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "store_id": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "contact_email": { "type": "string" }, "contact_phone": { "type": "string" }, "contact_name": { "type": "string" }, "notification_emails": { "type": "array", "items": { "type": "string" } }, "country": { "type": "string" }, "timezone": { "type": "string" }, "capacity": { "type": "number" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "store_id", "title", "address", "tags", "client_id", "store_type_name", "latitude", "longitude", "contact_email", "contact_phone", "contact_name", "notification_emails", "country", "timezone", "created_date", "updated_date" ] } } }, "example": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_id": "5b2122014ebf5300360acbd4", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "capacity": 100, "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acbde2", "title": "ice-cream-store-2", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "008", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store2.com", "contact_phone": "1800-008-008", "contact_name": "jane", "notification_emails": [ "james@store2.com", "jane@store2.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } ] } }, "examples": { "response": { "value": { "paging": { "total": 2, "skip": 0, "limit": 1000 }, "data": [ { "store_id": "5b2122014ebf5300360acbd4", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store.com", "contact_phone": "1800-007-007", "contact_name": "james", "notification_emails": [ "james@store.com", "jane@store.com" ], "country": "United States", "timezone": "America/New_York", "capacity": 100, "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acbde2", "title": "ice-cream-store-2", "address": "Statue of Liberty, New York, USA", "tags": [ "ICE ICE BABY" ], "client_id": "008", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "contact_email": "support@store2.com", "contact_phone": "1800-008-008", "contact_name": "jane", "notification_emails": [ "james@store2.com", "jane@store2.com" ], "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-07-20T09:51:40.862Z" } ] } } } } } } }, "summary": "Get all archives", "operationId": "Get all archives", "description": "Get all archived stores. You can use the same filters as for the regular “Get all stores” method", "tags": [ "Stores" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/stores/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Stores" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/stores": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "store_id": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "country": { "type": "string" }, "timezone": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "required": [ "store_id", "title", "address", "tags", "client_id", "store_type_name", "latitude", "longitude", "country", "timezone", "created_date", "updated_date" ] }, "example": [ { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-05-23T04:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acae2", "title": "another-ice-cream-store", "address": "77th Street, East Elmhurst, NY, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.765361, "longitude": -73.8940281, "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-05-23T04:51:40.862Z" } ] }, "examples": { "response": { "value": [ { "store_id": "5b2122014ebf5300360acae1", "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.6895453, "longitude": -74.0449292, "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-05-23T04:51:40.862Z" }, { "store_id": "5b2122014ebf5300360acae2", "title": "another-ice-cream-store", "address": "77th Street, East Elmhurst, NY, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "latitude": 40.765361, "longitude": -73.8940281, "country": "United States", "timezone": "America/New_York", "created_date": "2018-05-23T04:51:40.862Z", "updated_date": "2018-05-23T04:51:40.862Z" } ] } } } } } }, "summary": "Create", "operationId": "Create", "description": "You may create a new single store or multiple stores using this action. \nWhen creating a single store the body contains a json object, when creating multiple stores the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**", "tags": [ "Stores" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "address": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "client_id": { "type": "string" }, "store_type_name": { "type": "string" }, "capacity": { "type": "number" } }, "example": { "title": "ice-cream-store", "address": "Statue of Liberty, New York, USA", "tags": [ "The dream ice-cream", "number 1 ice-cream" ], "client_id": "007", "store_type_name": "ice-cream", "capacity": 100 } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/stores_archived/export?type={type}&filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export archived stores", "operationId": "Export archived stores", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Stores" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/stores/archive/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import Stores To Archive", "operationId": "Import Stores To Archive", "description": "This method will archive all stores found from the imported file.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n|`store_id` | string | x | Unique store id |\n|`client_id` | string | x | The external unique id of the store as it may exists in your Information System|\n\nOnly one of store_id or client_id is required", "tags": [ "Stores" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/stores/unarchive/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import Stores To Un Archive", "operationId": "Import Stores To Un Archive", "description": "This method will unarchive all stores found from the imported file.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n|`store_id` | string | x | Unique store id |\n|`client_id` | string | x | The external unique id of the store as it may exists in your Information System|\n\nOnly one of store_id or client_id is required", "tags": [ "Stores" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/stores/export?{filter}&type={type}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Stores" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/stores/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import", "operationId": "Import", "description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Field | Format | Required | Description |\n|--------------------------|---------|:--------:|-----------------|\n|`store_id` | string | | Unique store id |\n|`title` | string | x | Name of the store|\n|`address` | string | x | The full address allows us to locate the store on the map. This is used to display the missions available near the user's position. |\n|`tags` | string | | Tags allow to specify additional information about the store in the form \"AAA,BBB\" - multiple tags are comma separated, and we only use capital letter by convention |\n|`latitude` | float | | Latitude of the store in the form \"0.00\" |\n|`longitude` | float | | Longitude of the store in the form \"0.00\" |\n|`client_id` | string | x | The external unique id of the store as it may exists in your Information System|\n|`store_type_name` | string | x | The name of the store type|\n|`store_type_id` | string | | The id of the store type|\n|`info` | string | | Additional information regarding the store. Supports HTML layout |\n|`notification_emails` | array | | List of email(s) that will be notified when a mission is finished and/or a request is created/finished |\n|`contact_email` | string | | Contact's email of the store i.e. store manager's email |\n|`contact_phone` | string | | Contact's phone of the store i.e. store manager's phone |\n|`contact_name` | string | | Contact's name of the store i.e. store manager's name |\n|`properties` | string | | (.json format) Will enable you to customize the display of the data shown on the Store Activity Page. This can be split into 4 components (Columns, Grid, Chart and HTML |\n|`timezone` | string | | The Time Zone allows to display the hourly sales data in the store insights in the local time of the store. |\n|`capacity` | number | | Maximum number of customers which can be served at the same time |\n\nOne of either fields is required:\n\n- address\n\n- geoloc (latitude + longitude)\n\nIn the case one of the field is missing the other one will be inferred automatically by using Google Map API. Please note that the results may be incorrect and it is always recommanded to supply both fields.\n\nOne of either fields is required:\n\n- store_type_name\n\n- store_type_id\n\n**important**:\n\n- If you are using `custom_fields`, you can also add columns corresponding to the name of each of your `custom_fields` in your import file\n\n- the `client_id` is used as primary key when importing a store file. This means you don’t need to store the YOOBIC `store_id` in your systems. For each row in the import file, the import process will check if a store exists in the database with the same `client_id`:\n\n * If the `client_id` is found and the store is not archived, then the store is updated\n * If the `client_id` is not found, a new store is created\n * If the `client_id` is found and the store is archived, an error is returned to indicate this store is archived", "tags": [ "Stores" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/tenants?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Get All", "operationId": "Get All", "description": "Get the tenant data.", "tags": [ "Tenants" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/translations/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "translation_id": { "type": "string" }, "language": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" }, "us": { "type": "string" }, "en": { "type": "string" }, "ca": { "type": "string" }, "fr": { "type": "string" }, "de": { "type": "string" }, "es": { "type": "string" }, "nl": { "type": "string" }, "pl": { "type": "string" }, "it": { "type": "string" }, "ru": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "group_ids": { "type": "array", "items": { "type": "string" } } }, "example": { "translation_id": "587de6c4e000eb001877e3a1", "language": "fr", "key": "ACTIONPLANCAMPAIGNDESCRIPTION", "value": "Faites le tour du magasin avec cette fiche de visite", "us": "Walk around the store with the visit sheet", "en": "Walk around the store with the visit sheet", "ca": "Walk around the store with the visit sheet", "fr": "Faites le tour du magasin avec cette fiche de visite", "de": "Gehen Sie um den Laden mit dem Besuch Blatt", "es": "Paseo por la tienda con la hoja de visita", "nl": "Loop rond de winkel met het bezoek vel", "pl": "Spacer po sklepie z arkuszem wizyty", "it": "Passeggiata intorno al negozio con la scheda di visita", "ru": "Прогулка вокруг магазина с посещением листа", "created_date": "2017-01-17T09:41:24.401Z", "updated_date": "2017-01-18T15:27:49.026Z", "group_ids": [ "yoobicprojectmanager" ] } }, "examples": { "response": { "value": { "translation_id": "587de6c4e000eb001877e3a1", "language": "fr", "key": "ACTIONPLANCAMPAIGNDESCRIPTION", "value": "Faites le tour du magasin avec cette fiche de visite", "us": "Walk around the store with the visit sheet", "en": "Walk around the store with the visit sheet", "ca": "Walk around the store with the visit sheet", "fr": "Faites le tour du magasin avec cette fiche de visite", "de": "Gehen Sie um den Laden mit dem Besuch Blatt", "es": "Paseo por la tienda con la hoja de visita", "nl": "Loop rond de winkel met het bezoek vel", "pl": "Spacer po sklepie z arkuszem wizyty", "it": "Passeggiata intorno al negozio con la scheda di visita", "ru": "Прогулка вокруг магазина с посещением листа", "created_date": "2017-01-17T09:41:24.401Z", "updated_date": "2017-01-18T15:27:49.026Z", "group_ids": [ "yoobicprojectmanager" ] } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a translation for the given id.", "tags": [ "Translations" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the translation", "required": true, "example": "54ab03c6546847ee0d30083e", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "delete": { "responses": { "204": { "description": "No Content", "headers": {} } }, "summary": "Delete", "operationId": "Delete", "description": "Delete a translation by id.", "tags": [ "Translations" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the translation", "required": true, "example": "54ab03c6546847ee0d30083e", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "patch": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Partial Update", "operationId": "Partial Update", "description": "Update a subset of properties of a translation", "tags": [ "Translations" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the translation", "required": true, "example": "54ab03c6546847ee0d30083e", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pr": { "type": "string" }, "ru": { "type": "string" } }, "example": { "pr": "personalizado", "ru": "обычай" } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/translations?filter={filter}": { "get": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Get All", "operationId": "Get All", "description": "Get all the translations.", "tags": [ "Translations" ], "parameters": [ { "name": "filter", "in": "query", "description": "A valid JSON filter object", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/translations": { "post": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Create", "operationId": "Create", "description": "You may create a new single translation or multiple translations using this action. \nWhen creating a single translation the body contains a json object, when creating multiple translations the body contains an array of objects. \n**Warning: a maximum of 1000 items can be sent in a single request.**", "tags": [ "Translations" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/translations/count?where={where}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "example": { "count": 10 } }, "examples": { "response": { "value": { "count": 10 } } } } } } }, "summary": "Count", "operationId": "Count", "description": "Count all the existing entities based on the where filter", "tags": [ "Translations" ], "parameters": [ { "name": "where", "in": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)", "required": false, "example": "{ \"property\": \"value\" }", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/translations/export?filter={filter}&type={type}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Export file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Export", "operationId": "Export", "description": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.", "tags": [ "Translations" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)", "required": false, "example": "{}", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Get_AllBody" } } }, "/public/api/translations/import?type={type}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "priority": { "type": "number" }, "nextRunAt": { "type": "string" }, "_id": { "type": "string" } }, "example": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } }, "examples": { "response": { "value": { "name": "Import file", "type": "normal", "priority": 0, "nextRunAt": "2018-09-11T15:56:05.387Z", "_id": "5b97e5954b99568b4b9101af" } } } } } } }, "summary": "Import", "operationId": "Import", "description": "See the [Import file section](#section-import-jobs) for more information.\n\n### Fields\n\n| Column | Format | Required | Description |\n|----------------------|-------------|-----------|----------------|\n|`translation_id` | string | | Unique id of the translations |\n|`language` | string | x | Default language chosen for the key |\n|`key` | string | x | The key that references this translation |\n|`value` | string | x | Translated key by the default language |\n|`group_ids` | array | x | Group ids that can see these translations |\n|`us` | string | | English - United States |\n|`en` | string | | English |\n|`ca` | string | | English - Canada |\n|`fr` | string | | French |\n|`de` | string | | German |\n|`es` | string | | Spanish |\n|`nl` | string | | Dutch |\n|`pl` | string | | Polish |\n|`it` | string | | Italian |\n|`ru` | string | | Russian |\n|`zhs` | string | | Simplified Chinese |\n|`zht` | string | | Traditional Chinese |\n|`pt` | string | | Portuguese |\n|`kr` | string | | Kanuri |\n|`ja` | string | | Japanese |\n|`ua` | string | | Ukrainian |\n|`he` | string | | Hebrew |\n|`ar` | string | | Arabic |\n|`cz` | string | | Czech |\n|`th` | string | | Thai |\n|`tr` | string | | Turkish |\n|`bg` | string | | Bulgarian |\n|`el` | string | | Greek |\n|`sl` | string | | Slovanian |\n|`sk` | string | | Slovak |\n|`ro` | string | | Romanian |\n|`hu` | string | | Hungarian |\n|`br` | string | | Brazilian Portuguese |\n|`et` | string | | Estonian |\n|`au` | string | | Australian |\n|`ido` | string | | Indonesian |\n|`vi` | string | | Vietnamese |\n|`da` | string | | Danish |\n|`fi` | string | | Finnish |\n|`nb` | string | | Norwegian |\n|`sv` | string | | Swedish |\n|`base_language` | string | | the base language code of the plan |\n|`updated_date` | date | | translations item last update date|\n|`created_date` | date | | translations item creation date |", "tags": [ "Translations" ], "parameters": [ { "name": "type", "in": "path", "description": "The type of file, either `csv` (default value) or `excel`", "required": true, "example": "csv", "schema": { "type": "string" } }, { "name": "Content-Disposition", "in": "header", "description": "e.g. form-data; name=\"file\"; filename=\"file.csv\"", "required": false, "example": "form-data; name=\"file\"; filename=\"file.csv\"", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ImportBody" } } }, "/public/api/users/me": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "tenant": { "type": "string" } }, "example": { "user_id": "53fb03c6546847fe0d30186b", "username": "mycompany+yoobicserviceaccount@mycompany.com", "email": "support+mycompany+yoobicserviceaccount@yoobic.com", "groups": [ "mycompany_group" ], "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z", "tenant": "mycompany" } }, "examples": { "response": { "value": { "user_id": "53fb03c6546847fe0d30186b", "username": "mycompany+yoobicserviceaccount@mycompany.com", "email": "support+mycompany+yoobicserviceaccount@yoobic.com", "groups": [ "mycompany_group" ], "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z", "tenant": "mycompany" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get the serivce account user for the current token.\n\n**Important:**\nThe `tenant` property returned by this endpoint contains the string value of the company name that should be used as the prefix for new [Groups](#reference/groups/multiple-groups-api/create).", "tags": [ "Users" ], "parameters": [ { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] } }, "/public/api/users/{id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string" }, "username": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "client_role": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "photo": { "type": "string" }, "store_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "allow_local_login": { "type": "boolean" }, "mobile_version": { "type": "string" }, "desktop_version": { "type": "string" }, "last_seen": { "type": "string" }, "client_id": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "updated_date": { "type": "string" } }, "example": { "user_id": "53fb03c6546847ee0d30086a", "username": "johndoe9@houston.com", "first_name": "John", "last_name": "Doe", "client_role": "ROLEVIEWER", "email": "johndoe9@houston.com", "groups": [ "test" ], "language": "en", "photo": "https://www.w3schools.com/w3images/avatar2.png", "store_id": "5739b18c6b8e2ac941fbee86", "tags": [ "regional" ], "allow_local_login": true, "mobile_version": "6.5.16", "desktop_version": "7.0.16-9", "last_seen": "2020-11-19T14:21:44.625Z", "client_id": [ "SITE_1" ], "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z" } }, "examples": { "response": { "value": { "user_id": "53fb03c6546847ee0d30086a", "username": "johndoe9@houston.com", "first_name": "John", "last_name": "Doe", "client_role": "ROLEVIEWER", "email": "johndoe9@houston.com", "groups": [ "test" ], "language": "en", "photo": "https://www.w3schools.com/w3images/avatar2.png", "store_id": "5739b18c6b8e2ac941fbee86", "tags": [ "regional" ], "allow_local_login": true, "mobile_version": "6.5.16", "desktop_version": "7.0.16-9", "last_seen": "2020-11-19T14:21:44.625Z", "client_id": [ "SITE_1" ], "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z" } } } } } } }, "summary": "Get", "operationId": "Get", "description": "Get a user for the given id.", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the User", "required": true, "example": "53fb03c6546847ee0d30086a", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "delete": { "responses": { "204": { "description": "No Content", "headers": {} } }, "summary": "Delete", "operationId": "Delete", "description": "Delete an user by id.", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the User", "required": true, "example": "53fb03c6546847ee0d30086a", "schema": { "type": "string" } } ], "security": [ { "oauth2": [] } ] }, "patch": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "string" }, "username": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "client_role": { "type": "string" }, "client_role_extension": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "photo": { "type": "string" }, "store_id": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "mobile_version": { "type": "string" }, "desktop_version": { "type": "string" }, "store_type_names": { "type": "array", "items": { "type": "string" } }, "last_seen": { "type": "string" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "weekly_schedule": { "type": "object", "properties": { "mon_hours": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } }, "tue_hours": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } }, "wed_hours": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } } } }, "thu_hours": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } }, "fri": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } } } } }, "example": { "user_id": "53fb03c6546847ee0d30086a", "username": "johndoe9@houston.com", "first_name": "John", "last_name": "Doe", "client_role": "ROLEMANAGER", "client_role_extension": "Super", "email": "johndoe9@houston.com", "groups": [ "test" ], "language": "en", "photo": "https://www.w3schools.com/w3images/avatar2.png", "store_id": "5739b18c6b8e2ac941fbee86", "tags": [ "The Dream", "Hakeem the Dream Olajuwon", "The Dream Shake" ], "mobile_version": "6.5.16", "desktop_version": "7.0.16-9", "store_type_names": [ "ST1", "ST2" ], "last_seen": "2020-11-19T14:21:44.625Z", "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z", "weekly_schedule": { "mon_hours": { "periods": [ { "from": "08:00", "to": "20:00" } ] }, "tue_hours": { "periods": [ { "from": "08:00", "to": "17:00" } ] }, "wed_hours": { "periods": [ { "from": "08:20", "to": "10:00" }, { "from": "11:00", "to": "16:20" } ] }, "thu_hours": { "periods": [ { "from": "08:00", "to": "20:10" } ] }, "fri": { "periods": [ { "from": "09:00", "to": "13:00" } ] } } } }, "examples": { "response": { "value": { "user_id": "53fb03c6546847ee0d30086a", "username": "johndoe9@houston.com", "first_name": "John", "last_name": "Doe", "client_role": "ROLEMANAGER", "client_role_extension": "Super", "email": "johndoe9@houston.com", "groups": [ "test" ], "language": "en", "photo": "https://www.w3schools.com/w3images/avatar2.png", "store_id": "5739b18c6b8e2ac941fbee86", "tags": [ "The Dream", "Hakeem the Dream Olajuwon", "The Dream Shake" ], "mobile_version": "6.5.16", "desktop_version": "7.0.16-9", "store_type_names": [ "ST1", "ST2" ], "last_seen": "2020-11-19T14:21:44.625Z", "created_date": "2019-02-10T17:20:11.531Z", "updated_date": "2020-11-10T12:11:15.439Z", "weekly_schedule": { "mon_hours": { "periods": [ { "from": "08:00", "to": "20:00" } ] }, "tue_hours": { "periods": [ { "from": "08:00", "to": "17:00" } ] }, "wed_hours": { "periods": [ { "from": "08:20", "to": "10:00" }, { "from": "11:00", "to": "16:20" } ] }, "thu_hours": { "periods": [ { "from": "08:00", "to": "20:10" } ] }, "fri": { "periods": [ { "from": "09:00", "to": "13:00" } ] } } } } } } } } }, "summary": "Partial Update", "operationId": "Partial Update", "description": "Update a subset of properties of an user. \n**Important** - `password` cannot be updated (will be ignored) via this endpoint.", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the User", "required": true, "example": "53fb03c6546847ee0d30086a", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "client_role_extension": { "type": "string" }, "store_type_names": { "type": "array", "items": { "type": "string" } }, "weekly_schedule": { "type": "object", "properties": { "fri": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } } } } }, "example": { "tags": [ "The Dream", "Hakeem the Dream Olajuwon", "The Dream Shake" ], "client_role_extension": "Super", "store_type_names": [ "ST1", "ST2" ], "weekly_schedule": { "fri": { "periods": [ { "from": "09:00", "to": "13:00" } ] } } } } } } }, "security": [ { "oauth2": [] } ] } }, "/public/api/users/{id}/password-change": { "patch": { "responses": { "200": { "description": "OK", "headers": {} } }, "summary": "Change Password", "operationId": "Change Password", "description": "Update user's `password`. \nNote - `dontSendMail` / boolean / not required / if `true` no email is sent to the user. If `false` or not specified, an email is sent to the user to inform them about the change.", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the user", "required": true, "example": "54ab03c6546847ee0d30086a", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "e.g. application/json", "required": false, "example": "application/json", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string" }, "dontSendMail": { "type": "boolean" } }, "example": { "password": "