Metadata

/api/Metadata/Binding

Get

Summary:

Returns all the bindings according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The binding list.	List of Binding

Post

Summary:

Creates a Binding.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the binding creation.	BindingCreatedResult

/api/Metadata/Binding/{id}

Get

Summary:

Returns a binding corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the binding.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The binding.	Binding

Put

Summary:

Updates a binding.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the binding to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the binding update.	BindingUpdatedResult

Delete

Summary:

Deletes a binding.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the binding to delete.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the binding delete.	BindingDeletedResult

/api/Metadata/BindingItem

Get

Summary:

Returns all the binding items according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The binding item list.	List of BindingItem

/api/Metadata/BindingItem/{id}

Get

Summary:

Returns a binding item corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the binding item.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The binding item.	BindingItem

/api/Metadata/Dimension

Get

Summary:

Returns all the dimensions according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The dimension list.	List of Dimension

Post

Summary:

Creates a dimension.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the dimension creation.	DimensionCreatedResult

/api/Metadata/Dimension/{id}

Get

Summary:

Returns a dimension corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the dimension.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The dimension.	Dimension

Put

Summary:

Updates a dimension.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the dimension to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the dimension update.	DimensionUpdatedResult

Delete

Summary:

Deletes a dimension.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the dimension to delete.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the dimension delete.	DimensionDeletedResult

/api/Metadata/EntityAssociation

Get

Summary:

Returns all the entity associations according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity association list.	List of EntityAssociation

Post

Summary:

Creates an entity association.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity association creation.	EntityAssociationCreatedResult

/api/Metadata/EntityAssociation/{id}

Get

Summary:

Returns an entity association corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity association.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity association.	EntityAssociation

Put

Summary:

Updates an entity association.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity association to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity association update.	EntityAssociationUpdatedResult

Delete

Summary:

Deletes an entity association.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity association to delete.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity association delete.	EntityAssociationDeletedResult

/api/Metadata/EntityProperty

Get

Summary:

Returns all the entity properties according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity property list.	List of EntityProperty

Post

Summary:

Creates an entity property.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity property creation.	EntityPropertyCreatedResult

/api/Metadata/EntityProperty/{id}

Get

Summary:

Returns an entity property corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity property.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity property.	EntityProperty

Put

Summary:

Updates an entity property.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity property to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity property update.	EntityPropertyUpdatedResult

Delete

Summary:

Deletes an entity property.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity property to delete.	True
force		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity property delete.	EntityPropertyDeletedResult

/api/Metadata/EntityType

Get

Summary:

Returns all the entity types according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity type list.	List of EntityType

Post

Summary:

Creates an entity type.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity type creation.	EntityTypeCreatedResult

/api/Metadata/EntityType/{id}

Get

Summary:

Returns an entity type corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity type.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The entity type.	EntityType

Put

Summary:

Updates an entity type.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity type to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity type update.	EntityTypeUpdatedResult

Delete

Summary:

Deletes an entity type.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the entity type to delete.	True
force		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the entity type delete.	EntityTypeDeletedResult

/api/Metadata/Language

Get

Summary:

Returns all the languages.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The single role list.	List of Language_

/api/Metadata/Setting

Get

Summary:

Returns all the settings according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
PageSize	Page size.	False
ContinuationToken	ContinuationToken returned by previous page request.	False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The single role list.	List of Setting

Post

Summary:

Creates a setting.

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the single role creation.	SettingCreatedResult

/api/Metadata/Setting/{id}

Get

Summary:

Returns a setting corresponding to the provided identifier and its information according to the provided query.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the setting.	True
squery	Query compliant to the API query grammar.	False
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The single role.	Setting

Put

Summary:

Updates a setting.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the setting to update.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the setting update.	SettingUpdatedResult

Delete

Summary:

Deletes a setting.

Parameters:

Name	Description	Required	Type	Reference
id	Identifier of the setting to delete.	True
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The result of the setting delete.	SettingDeletedResult

/api/Metadata/Setting/CustomLink/{url}

Get

Summary:

Returns the html data corresponding to the requested custom link url.

Parameters:

Name	Description	Required	Type	Reference
url	Url of the custom link.	True
Path	Represents the permission path.	False
QueryRootEntityType	Defines the query root entity type.	False
QueryBinding	Defines the query binding.	False
ApplyPostCondition	If true, use PostCondition access control rules.	False
AllowedAllJoinQuery		False
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	The html data.

/api/Metadata/Setting/GetFeatureFlags

Get

Parameters:

Name	Description	Required	Type	Reference
api-version	The requested API version	True

Responses:

Code	Description	Reference
200	OK