{ "opencollection": "1.0.0", "info": { "name": "Visier Analytic Model Data Model API", "version": "22222222.99201.3040" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "header" } }, "items": [ { "info": { "name": "DataModel", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of analytic objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The IDs of the analytic objects to retrieve. Default is all analytic objects." }, { "name": "objectType", "value": "", "type": "query", "description": "The object type to filter the returned analytic objects by." } ] }, "docs": "Retrieve all the analytic objects in your Visier solution." }, { "info": { "name": "Retrieve an analytic object by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." } ] }, "docs": "If you know the ID of an analytic object, use this API to retrieve that object specifically." }, { "info": { "name": "Retrieve a list of metrics for an analytic object by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:id/metrics", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve metrics for." } ] }, "docs": "If you know the ID of an analytic object, use this API to retrieve metrics for that object specifically." }, { "info": { "name": "Retrieve a list of dimensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/dimensions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the dimensions to retrieve. Default is all dimensions." } ] }, "docs": "Retrieve a list of dimensions for a specific analytic object." }, { "info": { "name": "Validate a member map's unmapped dimension members by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/dimensions/:dimensionId/mappings/validate", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object." }, { "name": "dimensionId", "value": "", "type": "path", "description": "The ID of a dimension of the member map." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If you know the ID of a member map, use this API to validate one of the member map's dimensions. \n You must also know the dimension's ID and the analytic object's ID. \n The response returns the member map ID, the requested dimension ID, a list of the dimension's unmapped members, and a list of errors found." }, { "info": { "name": "Retrieve a list of dimension members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/dimensions/:dimensionId/members", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object." }, { "name": "dimensionId", "value": "", "type": "path", "description": "The ID of the dimension." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the members to retrieve. Default is all members." }, { "name": "maxLevel", "value": "", "type": "query", "description": "The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels." }, { "name": "filter", "value": "", "type": "query", "description": "A regular expression that members must match to be retrieved. Default is to retrieve all members." }, { "name": "field", "value": "", "type": "query", "description": "Indicates the aspect of the member to apply the filter to. Possible values are:\n - **id**: Match the filter to the member ID.\n - **display**: Match the filter to the member's display name.\n - **either**: Match the filter to the member ID or display name.\n\n Default is `id`." }, { "name": "includeDataMembers", "value": "", "type": "query", "description": "Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`." }, { "name": "offset", "value": "", "type": "query", "description": "For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored." }, { "name": "limit", "value": "", "type": "query", "description": "For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1 to return up to 15,000 members. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored. If pagination occurs, the response status code is 206." }, { "name": "sortType", "value": "", "type": "query", "description": "The order of the members in the response. Valid values:\n - `configured`: Sorts the members according to their configuration. For parent-child dimensions, sorts members by name in ascending order. For other dimensions, sorts members by their configured order in Studio.\n - `natural`: Does not sort the members. This is the default." } ] }, "docs": "If you know the ID of a dimension, use this API to retrieve the members of that dimension specifically. You must\n also know the analytic object's ID. Dimension members exist in a hierarchy. The levels in the hierarchy may be\n fixed or non-uniform. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform\n levels. When you retrieve dimension members with this API, the response returns the level of the dimension and the\n path to get to that level. For example, in a " }, { "info": { "name": "Retrieve a dimension member", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/dimensions/:dimensionId/members/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object." }, { "name": "dimensionId", "value": "", "type": "path", "description": "The ID of the dimension." }, { "name": "id", "value": "", "type": "path" }, { "name": "Id", "value": "", "type": "query", "description": "The ID of the member to retrieve." } ] }, "docs": "If you know the ID of a dimension member, use this API to retrieve that dimension member specifically. You must also know the dimension's ID and the analytic object's ID." }, { "info": { "name": "Retrieve a dimension by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/dimensions/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the dimension to retrieve." } ] }, "docs": "If you know the ID of a dimension, use this API to retrieve that dimension specifically. You must also know the analytic object's ID." }, { "info": { "name": "Retrieve a list of properties", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/properties", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the properties to retrieve. Default is all properties." } ] }, "docs": "Retrieve a list of properties for a specific analytic object." }, { "info": { "name": "Retrieve a property by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/properties/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the property to retrieve." } ] }, "docs": "If you know the ID of a property, use this API to retrieve that property specifically. You must also know the analytic object's ID.." }, { "info": { "name": "Retrieve an analytic object's selection concepts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/selection-concepts", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the selection concepts to retrieve. Default is all selection concepts." } ] }, "docs": "Retrieve a list of selection concepts for a specific analytic object." }, { "info": { "name": "Retrieve an analytic object's selection concept by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/analytic-objects/:objectId/selection-concepts/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "objectId", "value": "", "type": "path", "description": "The ID of the analytic object to retrieve." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the selection concept to retrieve." } ] }, "docs": "If you know the ID of a selection concept, use this API to retrieve that selection concept specifically. You must also know the analytic object's ID." }, { "info": { "name": "Retrieve all currencies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/currencies", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ] }, "docs": "Retrieve all the available currencies in your Visier solution." }, { "info": { "name": "Retrieve a currency", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/currencies/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ISO 4217 3-letter code for the currency." } ] }, "docs": "Retrieve a specific currency if you know the currency code." }, { "info": { "name": "Retrieve all exchange rates for a currency", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/currencies/:id/rates", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ISO 4217 3-letter code for the currency to get rates for." }, { "name": "startTime", "value": "", "type": "query", "description": "The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds." }, { "name": "endTime", "value": "", "type": "query", "description": "The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds." }, { "name": "decimals", "value": "", "type": "query", "description": "The number of decimals to round exchange rates to. Default is to round to 2 decimal places." } ] }, "docs": "Retrieve exchange rates for a specific currency from Visier.\n You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to." }, { "info": { "name": "Retrieve exchange rates from one currency to another currency", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/currencies/:id/rates/:toId", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ISO 4217 3-letter code for the currency to convert from." }, { "name": "toId", "value": "", "type": "path", "description": "The ISO 4217 3-letter code for the currency to convert to." }, { "name": "startTime", "value": "", "type": "query", "description": "The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds." }, { "name": "endTime", "value": "", "type": "query", "description": "The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds." }, { "name": "decimals", "value": "", "type": "query", "description": "The number of decimals to round exchange rates to. Default is to round to 2 decimal places." } ] }, "docs": "Retrieve exchange rates from a specific currency to another specific currency.\n You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to." }, { "info": { "name": "Update dimensions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/data/model/dimensions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the display name, short display name, and description of one or more dimensions. This API supports updating leveled dimensions.\n In each API request, update up to 10 dimensions per tenant with a maximum of 500 tenants." }, { "info": { "name": "Retrieve a list of metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/metrics", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The IDs of the metrics to retrieve. Default is all metrics." }, { "name": "category", "value": "", "type": "query", "description": "The category to filter the returned metrics by." } ] }, "docs": "Retrieve all the metrics in your Visier solution." }, { "info": { "name": "Retrieve a metric by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/metrics/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the metric to retrieve." } ] }, "docs": "If you know the ID of a metric, use this API to retrieve that metric specifically." }, { "info": { "name": "Retrieve a metric's dimensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/metrics/:metricId/dimensions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "metricId", "value": "", "type": "path", "description": "The ID of the metric to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the dimensions to retrieve. Default is all dimensions." } ] }, "docs": "Retrieve a list of dimensions for a specific metric." }, { "info": { "name": "Retrieve a metric's selection concepts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/metrics/:metricId/selection-concepts", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "metricId", "value": "", "type": "path", "description": "The ID of the metric to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the selection concepts to retrieve. Default is all selection concepts." } ] }, "docs": "Retrieve a list of selection concepts for a specific metric." }, { "info": { "name": "Retrieve a list of planning models", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/plan-models", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The IDs of the planning models to retrieve. Default is all models." } ] }, "docs": "Retrieve all the planning models you have access to." }, { "info": { "name": "Retrieve a planning model by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/plan-models/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the planning model to retrieve." } ] }, "docs": "Retrieve a specific planning model you have access to." }, { "info": { "name": "Retrieve metrics by planning model ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/plan-models/:id/metrics", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the planning model to retrieve." } ] }, "docs": "Retrieve all the metrics you have access to for a planning model." }, { "info": { "name": "Retrieve a list of plans by planning model ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/plan-models/:modelId/plans", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The ID of the planning model to retrieve." }, { "name": "id", "value": "", "type": "query", "description": "The IDs of the plans to retrieve. Default is all plans." } ] }, "docs": "Retrieve all the plans you have access to for a planning model." }, { "info": { "name": "Retrieve a plan by planning model ID and plan ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/plan-models/:modelId/plans/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "modelId", "value": "", "type": "path", "description": "The ID of the planning model to retrieve." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the plan to retrieve." } ] }, "docs": "Retrieve a specific plan that you have access to in a planning model." }, { "info": { "name": "Retrieve a list of predictions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/predictions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The IDs of the predictions to retrieve. Default is all predictions." } ] }, "docs": "Retrieve all the predictions in your Visier solution." }, { "info": { "name": "Retrieve a prediction by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/predictions/:id", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the prediction to retrieve." } ] }, "docs": "If you know the ID of a prediction, use this API to retrieve that prediction specifically." }, { "info": { "name": "Create properties", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/data/model/properties", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new properties. Administrating tenant users can specify the tenant in which to add these properties." }, { "info": { "name": "Replace properties", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/data/model/properties", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing properties by replacing their entire definition. The definition in your API call replaces the property's prior definition. You must provide the entire definition in the PUT call. If you omit values from the update request, those values are removed from the property. We recommend that you retrieve a property's details before you update the property with new values. This operation does not create new properties if they do not exist.\n In each API request, update up to 10 properties " }, { "info": { "name": "Update properties", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/data/model/properties", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the display name, short display name, and description of one or more properties. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants." }, { "info": { "name": "Delete properties", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/data/model/properties", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete existing properties. Administrating tenant users can specify the tenant in which to delete the properties.\n In each API request, delete up to 10 properties per tenant with a maximum of 500 tenants." }, { "info": { "name": "Retrieve a list of all Vee question categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories", "headers": [ { "name": "TargetTenantID", "value": "" } ] }, "docs": "Get a list of all categories for Vee sample questions. Administrating tenants can specify the tenant from which to retrieve categories using the `TargetTenantID` header." }, { "info": { "name": "Create Vee question categories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new sample question categories for Vee sample questions. Administrating tenants can specify the tenant in which to add sample question categories using the `TargetTenantID` header." }, { "info": { "name": "Update Vee question categories", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing Vee sample question categories, such as its display name or icon. Administrating tenants can specify the tenant in which to update categories using the `TargetTenantID` header.\n\n When updating categories, the category definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a " }, { "info": { "name": "Partially update Vee question categories", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make partial changes to Vee sample question categories. Administrating tenants can specify the tenant in which to patch categories using the `TargetTenantID` header.\n\n Unlike a `PUT` call, which completely replaces the sample question category definition, use `PATCH` to change specific fields in the category without affecting omitted fields." }, { "info": { "name": "Delete Vee question categories", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete existing Vee sample question categories. Administrating tenants can specify the tenant in which to delete categories using the `TargetTenantID` header." }, { "info": { "name": "Retrieve a Vee question category's details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/vee/sample-question-categories/:questionCategoryId", "headers": [ { "name": "TargetTenantID", "value": "" } ], "params": [ { "name": "questionCategoryId", "value": "", "type": "path", "description": "The ID of the Vee sample question category to retrieve." } ] }, "docs": "Get the details of a specific Vee sample question category where the ID is the `categoryID` returned by `GET /v1/data/model/vee/sample-question-categories`." }, { "info": { "name": "Retrieve a list of all Vee sample questions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ] }, "docs": "Get a list of all Vee sample questions for a tenant, including sample questions that are not available to end users. Administrating tenants can specify the tenant from which to retrieve sample questions using the `TargetTenantID` header." }, { "info": { "name": "Add Vee sample questions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new sample questions that your users can ask Vee. Administrating tenants can specify the tenant in which to add sample questions using the `TargetTenantID` header." }, { "info": { "name": "Update Vee sample questions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing sample questions, such as its question category or whether the question is visible in Vee. Administrating tenants can specify the tenant in which to update sample questions using the `TargetTenantID` header.\n When updating sample questions, the question definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default valu" }, { "info": { "name": "Patch Vee sample questions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make partial changes to Vee sample questions. Administrating tenants can specify the tenant in which to patch questions using the `TargetTenantID` header.\n Unlike a `PUT` call, which completely replaces the sample question definition, use `PATCH` to change specific fields in the question without affecting omitted fields." }, { "info": { "name": "Delete Vee sample questions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete existing sample questions. Administrating tenants can specify the tenant in which to delete questions using the `TargetTenantID` header." }, { "info": { "name": "Retrieve a Vee sample question's details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/data/model/vee/sample-questions/:questionId", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" } ], "params": [ { "name": "questionId", "value": "", "type": "path", "description": "The ID of the Vee sample question to retrieve." } ] }, "docs": "Get the details of a specific Vee sample question where the ID is the `questionID` returned by `GET /v1/data/model/vee/sample-questions`." }, { "info": { "name": "Retrieve a list of plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/planning/model/plans", "headers": [ { "name": "TargetTenantID", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\"." }, { "name": "model", "value": "", "type": "query", "description": "Returns plans that belong to the specified planning model ID." }, { "name": "planStatus", "value": "", "type": "query", "description": "Returns plans with the specified plan status. Valid values:\n - **ASSIGNED**: The subplan has been assigned to a subplanner.\n - **IN_PROGRESS**: The subplanner has opened the subplan.\n - **OVERDUE**: The subplan was not completed on time.\n - **SUBMITTED**: The subplan has been submitted for review.\n - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing.\n - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan." }, { "name": "createdStart", "value": "", "type": "query", "description": "Returns plans created on or after this date. The format is YYYY-MM-DD." }, { "name": "createdEnd", "value": "", "type": "query", "description": "Return plans created on or before this date. The format is YYYY-MM-DD." }, { "name": "editedStart", "value": "", "type": "query", "description": "Returns plans edited on or after this date. The format is YYYY-MM-DD." }, { "name": "editedEnd", "value": "", "type": "query", "description": "Returns plans edited on or before this date. The format is YYYY-MM-DD." }, { "name": "orderBy", "value": "", "type": "query", "description": "Orders plan results by the specified value. Valid values:\n - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default.\n - **CREATED_DATE**: Orders plans by the creation date.\n - **PLAN_MODEL**: Orders plans alphabetically by planning model." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`." }, { "name": "excludeSubplans", "value": "", "type": "query", "description": "If `true`, the response doesn't return subplans. Default is `true`." }, { "name": "maxResults", "value": "", "type": "query", "description": "Sets the maximum number of results to return per page. Default is 50." }, { "name": "page", "value": "", "type": "query", "description": "Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`." } ] }, "docs": "Retrieve all the plans you have access to. The response returns plan information you can use to call the Plan Data Load API and Plan Administration API." }, { "info": { "name": "Retrieve a plan's details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/planning/model/plans/:id", "headers": [ { "name": "TargetTenantID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the plan." }, { "name": "withSchema", "value": "", "type": "query", "description": "If `true`, the response returns the plan's schema. Default is `false`." }, { "name": "segmentIdFilter", "value": "", "type": "query", "description": "If defined, returns segment levels and members for the specified segment." } ] }, "docs": "Retrieve the details of a specific plan. The response returns plan information you can use to call the Plan Data Load API." } ] } ], "bundled": true }