Solyp is designed to bring order and clarity to your strategic processes, empowering you to exceed your goals. Work systematically, collaboratively and effectively on all aspects of strategy and leadership. Succeed decisively in the age of digitization.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Echo |
|
MapValue (string name, string value, array mappings, [Optional]string def) |
Map a value |
Get a mapping schema |
|
Get all period types |
|
Ping |
|
Get all roadmaps |
|
Get a roadmap |
|
Get all attributes |
|
Get all custom properties |
|
Get schema of all custom properties |
|
Get all roadmap dimension 1 items |
|
Get all roadmap dimension 2 items |
|
Get all roadmap dimension 3 items |
|
Get all roadmap dimension 4 items |
|
Get all roadmap dimension 5 items |
|
Get all roadmap impacts |
|
Get all integration systems |
|
Get schema for array of items |
|
Get all items |
|
Create a new item |
|
FindItemsByIntegrationSystem (string roadmapId, string integrationKey) |
Find items by integration system |
Get an item |
|
Update an item |
|
Get all item dimension 1 items |
|
Get all item dimension 2 items |
|
Get all item dimension 3 items |
|
Get all item dimension 4 items |
|
Get all item dimension 5 items |
|
Get all item impacts |
|
Set an impact value |
|
Get available item impact value types |
|
Get available item period types |
|
Get schema for items |
|
Get all item types |
|
Get all units |
|
Get all roadmap years |
|
Get a user |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Echo
Description: Respond with the request.
Syntax:
SOLYP.Echo ()
Returns:
Type:string
Summary: Map a value
Description: Map a value to another value.
Syntax:
SOLYP.MapValue (string name, string value, array mappings, [Optional]string def)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
name |
string (Name) |
The mapping name |
True |
|
value |
string (Value) |
The value to map |
True |
|
mappings |
array of (Mapping)
|
|
True |
|
def |
string (Default) |
The default value that will be returned if no mapping matches |
False |
Returns:
Type:MapValueResponse
Summary: Get a mapping schema
Description: Get a mapping schema.
Syntax:
SOLYP.GetMappingSchema (string title)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
title |
string (Title) |
The schema title |
True |
Returns:
Summary: Get all period types
Description: Get all period types.
Syntax:
SOLYP.GetPeriodTypes ()
Returns:
Type:array of (PeriodType)
Summary: Ping
Description: Alive ping.
Syntax:
SOLYP.Ping ()
Returns:
Summary: Get all roadmaps
Description: Get all roadmaps.
Syntax:
SOLYP.GetRoadmaps ()
Returns:
Type:array of (Roadmap)
Summary: Get a roadmap
Description: Get a roadmap.
Syntax:
SOLYP.GetRoadmap (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:Roadmap
Summary: Get all attributes
Description: Get all attributes.
Syntax:
SOLYP.GetAttributes (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:array of (Attribute)
Summary: Get all custom properties
Description: Get all custom properties
Syntax:
SOLYP.GetCustomProperties (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:array of (CustomProperty)
Summary: Get schema of all custom properties
Description: Get schema of all custom properties
Syntax:
SOLYP.GetCustomPropertiesSchema (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:GetCustomPropertiesSchemaResponse
Summary: Get all roadmap dimension 1 items
Description: Get all roadmap dimension 1 items
Syntax:
SOLYP.GetDimension01Items (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all roadmap dimension 2 items
Description: Get all roadmap dimension 2 items
Syntax:
SOLYP.GetDimension02Items (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all roadmap dimension 3 items
Description: Get all roadmap dimension 3 items
Syntax:
SOLYP.GetDimension03Items (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all roadmap dimension 4 items
Description: Get all roadmap dimension 4 items
Syntax:
SOLYP.GetDimension04Items (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all roadmap dimension 5 items
Description: Get all roadmap dimension 5 items
Syntax:
SOLYP.GetDimension05Items (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all roadmap impacts
Description: Get all roadmap impacts
Syntax:
SOLYP.GetFactImpacts (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (FactImpact)
Summary: Get all integration systems
Description: Get all integration systems.
Syntax:
SOLYP.GetIntegrationSystems (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:array of (IntegrationSystem)
Summary: Get schema for array of items
Description: Get schema for array of items including all custom properties
Syntax:
SOLYP.GetItemArraySchema (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:GetItemArraySchemaResponse
Summary: Get all items
Description: Get all items.
Syntax:
SOLYP.GetItems (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:GetItemsResponse
Summary: Create a new item
Description: Create a new item.
Syntax:
SOLYP.CreateItem (string roadmapId, string itemTypeId, string name, [Optional]string shortName, [Optional]string description, string periodType, [advanced][Optional]string startDate, [advanced][Optional]string endDate, [Optional]CreateItemParameterCustomProperties customProperties)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
|
itemTypeId |
string(uuid) (Item Type) |
The item type id |
True |
|
name |
string (Name) |
The name |
True |
|
shortName |
string (Short Name) |
The short name |
False |
|
description |
string (Description) |
The description |
False |
|
periodType |
string (Period Type) |
The period type |
True |
|
startDate |
string(date-time) (Start Date) |
The start date |
False |
|
endDate |
string(date-time) (End Date) |
The end date |
False |
|
customProperties |
CreateItemParameterCustomProperties
|
|
False |
Returns:
Type:CreateItemResponse
Summary: Find items by integration system
Description: Find items by integration system.
Syntax:
SOLYP.FindItemsByIntegrationSystem (string roadmapId, string integrationKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
|
integrationKey |
string (Integration System) |
The integration system |
True |
Returns:
Type:FindItemsByIntegrationSystemResponse
Summary: Get an item
Description: Get an item.
Syntax:
SOLYP.GetItem (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item) |
The item id |
True |
Returns:
Type:GetItemResponse
Summary: Update an item
Description: Update an item.
Syntax:
SOLYP.UpdateItem (string roadmapId, string itemId, [Optional]string parentId, [Optional]string itemTypeId, [Optional]string name, [Optional]string shortName, [Optional]string description, [Optional]string periodType, [advanced][Optional]string startDate, [advanced][Optional]string endDate, [Optional]UpdateItemParameterCustomProperties customProperties)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item) |
The item id |
True |
|
parentId |
string(uuid) (Parent) |
The parent id |
False |
|
itemTypeId |
string(uuid) (Item Type) |
The item type id |
False |
|
name |
string (Name) |
The name |
False |
|
shortName |
string (Short Name) |
The short name |
False |
|
description |
string (Description) |
The description |
False |
|
periodType |
string (Period Type) |
The period type |
False |
|
startDate |
string(date-time) (Start Date) |
The start date |
False |
|
endDate |
string(date-time) (End Date) |
The end date |
False |
|
customProperties |
UpdateItemParameterCustomProperties
|
|
False |
Returns:
Type:UpdateItemResponse
Summary: Get all item dimension 1 items
Description: Get all item dimension 1 items
Syntax:
SOLYP.GetItemDimension01Items (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all item dimension 2 items
Description: Get all item dimension 2 items
Syntax:
SOLYP.GetItemDimension02Items (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all item dimension 3 items
Description: Get all item dimension 3 items
Syntax:
SOLYP.GetItemDimension03Items (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all item dimension 4 items
Description: Get all item dimension 4 items
Syntax:
SOLYP.GetItemDimension04Items (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all item dimension 5 items
Description: Get all item dimension 5 items
Syntax:
SOLYP.GetItemDimension05Items (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (DimensionItem)
Summary: Get all item impacts
Description: Get all item impacts
Syntax:
SOLYP.GetImpacts (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (Impact)
Summary: Set an impact value
Description: Set an impact value.
Syntax:
SOLYP.SetImpactValue (string roadmapId, string itemId, string attributeId, [Optional]string dimension01ItemId, [Optional]string dimension02ItemId, [Optional]string dimension03ItemId, [Optional]string dimension04ItemId, [Optional]string dimension05ItemId, [Optional]integer partition, string periodType, integer year, string valueType, [Optional]number amount)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
|
attributeId |
string(uuid) (Attribute Id) |
The attribute id |
True |
|
dimension01ItemId |
string(uuid) (Dimension 1 Item Id) |
The dimension 1 item id |
False |
|
dimension02ItemId |
string(uuid) (Dimension 2 Item Id) |
The dimension 2 item id |
False |
|
dimension03ItemId |
string(uuid) (Dimension 3 Item Id) |
The dimension 3 item id |
False |
|
dimension04ItemId |
string(uuid) (Dimension 4 Item Id) |
The dimension 4 item id |
False |
|
dimension05ItemId |
string(uuid) (Dimension 5 Item Id) |
The dimension 5 item id |
False |
|
partition |
integer(int32) (Partition) |
The partition |
False |
|
periodType |
string (Period Type) |
The period type |
True |
|
year |
integer(int32) (Year) |
The year |
True |
|
valueType |
string (Value Type) |
The value type |
True |
|
amount |
number(double) (Amount) |
The amount |
False |
Returns:
Type:ImpactValue
Summary: Get available item impact value types
Description: Get available item impact value types
Syntax:
SOLYP.GetItemImpactValueTypes (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (ImpactValueType)
Summary: Get available item period types
Description: Get available item period types
Syntax:
SOLYP.GetItemPeriodTypes (string roadmapId, string itemId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
|
itemId |
string(uuid) (Item Id) |
The item id |
True |
Returns:
Type:array of (PeriodType)
Summary: Get schema for items
Description: Get schema for items including all custom properties
Syntax:
SOLYP.GetItemSchema (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Summary: Get all item types
Description: Get all item types.
Syntax:
SOLYP.GetItemTypes (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:array of (ItemType)
Summary: Get all units
Description: Get all units.
Syntax:
SOLYP.GetUnits (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap) |
The roadmap id |
True |
Returns:
Type:array of (Unit)
Summary: Get all roadmap years
Description: Get all roadmap years
Syntax:
SOLYP.GetYears (string roadmapId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roadmapId |
string(uuid) (Roadmap Id) |
The roadmap id |
True |
Returns:
Type:array of (Year)
Summary: Get a user
Description: Get a user.
Syntax:
SOLYP.GetUser (string userId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
userId |
string(uuid) (User) |
The user id |
True |
Returns:
Type:User
Summary:
Description:
Properties:
Name |
Type |
Summary |
attributeId |
string(uuid) Attribute Id |
The attribute id |
description |
string Unit Description |
The description of the unit |
name |
string Unit Name |
The name of the unit |
parentId |
string(uuid) Parent Id |
The parent id |
roadmapId |
string(uuid) Roadmap Id |
The roadmap id |
shortName |
string Unit Short Name |
The unique short name of the unit |
unitId |
string(uuid) Unit Id |
The unit id |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
allowMultipleValues |
boolean Custom Property Allows Multiple Values |
Does the custom property allow multiple values? |
customPropertyId |
string(uuid) Custom Property Id |
The id of the custom property |
dataType |
string Custom Property Data Type |
The data type of the custom property |
description |
string Custom Property Description |
The description of the custom property |
entityId |
string(uuid) Custom Property Roadmap Id |
The roadmap id of the custom property |
isMandatory |
boolean Custom Property Is Mandatory |
Is the custom property mandatory? |
name |
string Custom Property Name |
The name of the custom property |
shortName |
string Custom Property Short Name |
The unique short name of the custom property |
tenantId |
string(uuid) Custom Property Tenant Id |
The tenant id of the custom property |
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Description |
The description of the dimension item |
dimensionItemId |
string(uuid) Dimension Item Id |
The id of the dimension item |
externalId |
string External Id |
The external id of the dimension item |
isActive |
boolean Is Active |
Is the dimension item active |
isDeleted |
boolean Is Deleted |
Is the dimension item deleted |
name |
string Name |
The name of the dimension item |
parentId |
string(uuid) Parent Id |
The parent id of the dimension item |
shortName |
string Short Name |
The short name of the dimension item |
useForRemainder |
boolean Use for remainder |
Use for remainder of the dimension item |
Summary:
Description:
Properties:
Name |
Type |
Summary |
actualValues |
Impact Actual Values |
The actual values of the impact |
attributeId |
string(uuid) Impact Attribute Id |
The attribute id of the impact |
baselineValues |
Impact Baseline Values |
The baseline values of the impact |
degreeOfImplementationId |
string(uuid) Impact Degree of Implenentation Id |
The degree of implenentation id of the impact |
dimension01ItemId |
string(uuid) Impact Dimension 1 Item Id |
The dimension 1 item id of the impact |
dimension02ItemId |
string(uuid) Impact Dimension 2 Item Id |
The dimension 2 item id of the impact |
dimension03ItemId |
string(uuid) Impact Dimension 3 Item Id |
The dimension 3 item id of the impact |
dimension04ItemId |
string(uuid) Impact Dimension 4 Item Id |
The dimension 4 item id of the impact |
dimension05ItemId |
string(uuid) Impact Dimension 5 Item Id |
The dimension 5 item id of the impact |
forecastValues |
Impact Forecast Values |
The forecast values of the impact |
itemId |
string(uuid) Impact Item Id |
The item id of the impact |
planValues |
Impact Plan Values |
The plan values of the impact |
roadmapId |
string(uuid)
|
|
scenarioId |
string(uuid) Impact Scenario Id |
The scenario id of the impact |
targetValues |
Impact Plan Values |
The plan values of the impact |
Summary: Impact Actual Values
Description: The actual values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Baseline Values
Description: The baseline values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Forecast Values
Description: The forecast values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Plan Values
Description: The plan values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Plan Values
Description: The plan values of the impact
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
actualValues |
Impact Actual Values |
The actual values of the impact |
attributeId |
string(uuid) Impact Attribute Id |
The attribute id of the impact |
baselineValues |
Impact Baseline Values |
The baseline values of the impact |
dimensionSplits |
Impact Dimension Splits |
The dimension splits of the impact |
forecastValues |
Impact Forecast Values |
The forecast values of the impact |
impactId |
string(uuid) Impact Id |
The impact id of the impact |
impactType |
string Impact type |
The impact type of the impact |
periodType |
string Impact Period Type |
The period type of the impact |
periodTypeValue |
integer(int32) Impact Period Type Value |
The period type value of the impact |
personId |
string(uuid) Impact Person Id |
the person id of the impact |
planValues |
Impact Plan Values |
The plan values of the impact |
targetValues |
Impact Target Values |
The target values of the impact |
unitId |
string(uuid) Impact Unit Id |
the unit id of the impact |
Summary: Impact Actual Values
Description: The actual values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Baseline Values
Description: The baseline values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Dimension Splits
Description: The dimension splits of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Forecast Values
Description: The forecast values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Plan Values
Description: The plan values of the impact
Properties:
Name |
Type |
Summary |
Summary: Impact Target Values
Description: The target values of the impact
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
amount |
number(double) Impact Value Ammount |
the amount of the impact value |
attributeId |
string(uuid) Impact Value Attribute Id |
The attribute id of the impact value |
dimension01ItemId |
string(uuid) Impact Value Dimension 1 Item Id |
The dimension 1 item id of the impact value |
dimension02ItemId |
string(uuid) Impact Value Dimension 2 Item Id |
The dimension 2 item id of the impact value |
dimension03ItemId |
string(uuid) Impact Value Dimension 3 Item Id |
The dimension 3 item id of the impact value |
dimension04ItemId |
string(uuid) Impact Value Dimension 4 Item Id |
The dimension 4 item id of the impact value |
dimension05ItemId |
string(uuid) Impact Value Dimension 5 Item Id |
The dimension 5 item id of the impact value |
impactSeriesId |
string(uuid) Impact Value Impact Series Id |
The impact series id of the impact value |
itemId |
string(uuid) Impact Value Item Id |
The item id of the impact value |
partition |
integer(int32) Impact Value Partition |
the partition of the impact value |
periodType |
string Impact Value Period Type |
the period type of the impact value |
personId |
string(uuid) Impact Value Persion Id |
The persion id of the impact value |
unitId |
string(uuid) Impact Value Unit Id |
the unit id of the impact value |
valueType |
string Impact Value Value Type |
the value type of the impact value |
year |
integer(int32) Impact Value Year |
the year of the impact value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
string Value |
The value of the impact value type |
valueType |
string Value type |
The type of the impact value type |
Summary:
Description:
Properties:
Name |
Type |
Summary |
brandColor |
string
|
|
iconUrl |
string
|
|
key |
string
|
|
name |
string
|
|
shortName |
string
|
|
viewUrl |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Item Type Description |
The description of the item type |
itemTypeId |
string(uuid) Item Type Id |
The id of the item type |
name |
string Item Type Name |
The name of the item type |
roadmapId |
string(uuid) Item Type Roadmap Id |
The roadmap id of the item type |
shortName |
string Item Type Short Name |
The unique short name of the item type |
Summary:
Description:
Properties:
Name |
Type |
Summary |
from |
string From |
The value to map from |
to |
string To |
The value to map to |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
key |
string
|
|
name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Roadmap Description |
The description of the roadmap |
isActive |
boolean Roadmap Active Flag |
The flag determing if the roadmap is active |
lastEditedBy |
string(uuid) Roadmap Last Edited By |
The id of the last user who edited the roadmap |
lastEditedOn |
string(date-time) Roadmap Last Edited On |
The last date when the roadmap has been edited |
name |
string Roadmap Name |
The name of the roadmap |
responsibleId |
string(uuid) Roadmap Responsible Id |
The id of the roadmap responsible |
roadmapId |
string(uuid) Roadmap Id |
The roadmap id |
shortName |
string Roadmap Short Name |
The unique short name of the roadmap |
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Unit Description |
The description of the unit |
name |
string Unit Name |
The name of the unit |
roadmapId |
string(uuid) Roadmap Id |
The roadmap id |
shortName |
string Unit Short Name |
The unique short name of the unit |
unitId |
string(uuid) Unit Id |
The unit id |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string User Display Name |
The display name of the user |
|
string User Email |
The email of the user |
givenName |
string User Given Name |
The given name of the user |
surname |
string User Surname |
The surname of the user |
userId |
string(uuid) User Id |
The user id |
Summary:
Description:
Properties:
Name |
Type |
Summary |
key |
integer(int32) Key |
The key of the year |
name |
string Name |
The name of the year |