Connectors Reference

AXtension Content Gate

Create a single point of truth for the content in your organization across Microsoft Dynamics 365 apps, by having all relevant content displayed in one overview, in one click.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

List-Business-Entity-Types (string providerReferenceId)

List Business Entity Types

List-Business-Entity-Connectors ()

List Business Entity Connectors

Store-Content ([internal]string Content-Type, [Optional]Store-ContentParameterBody body)

Store Content

List-Content-Categories ()

List Content Categories

Get-Content-Property-Schema ()

Get Content Entity properties schema

List-Storage-Connectors ()

List Storage Connectors

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Get-Content-Property-SchemaResponse

 

List-Business-Entity-ConnectorsResponseItem

 

List-Business-Entity-TypesResponseItem

 

List-Content-CategoriesResponseItem

 

List-Storage-ConnectorsResponseItem

 

Store-ContentParameterBody

 

UserProperties

 

 

Actions:

List-Business-Entity-Types

Summary: List Business Entity Types

Description: Lists all Business Entity Types in the Model

 

Syntax:

AXtensionContentGate.List-Business-Entity-Types (string providerReferenceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

providerReferenceId

string

 

 

True

 

Returns:

          Type:array of (List-Business-Entity-TypesResponseItem)

 

List-Business-Entity-Connectors

Summary: List Business Entity Connectors

Description: Lists all configured Business Entity Connectors.

 

Syntax:

AXtensionContentGate.List-Business-Entity-Connectors ()

 

Returns:

          Type:array of (List-Business-Entity-ConnectorsResponseItem)

 

Store-Content

Summary: Store Content

Description: Adds new content to an AXtension Content Gate environment.

 

Syntax:

AXtensionContentGate.Store-Content ([internal]string Content-Type, [Optional]Store-ContentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

Store-ContentParameterBody

 

 

False

 

Returns:

 

List-Content-Categories

Summary: List Content Categories

Description: Lists all configured content categories.

 

Syntax:

AXtensionContentGate.List-Content-Categories ()

 

Returns:

          Type:array of (List-Content-CategoriesResponseItem)

 

Get-Content-Property-Schema

Summary: Get Content Entity properties schema

Description: Gets the schema for the content entity properties.

 

Syntax:

AXtensionContentGate.Get-Content-Property-Schema ()

 

Returns:

          Type:Get-Content-Property-SchemaResponse

 

List-Storage-Connectors

Summary: List Storage Connectors

Description: Lists all configured storage connectors.

 

Syntax:

AXtensionContentGate.List-Storage-Connectors ()

 

Returns:

          Type:array of (List-Storage-ConnectorsResponseItem)

 


 

Get-Content-Property-SchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

List-Business-Entity-ConnectorsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

The identifier of the Business Entity Connector.

name

string

 

The name of the Business Entity Connector.

providerType

string

 

The type of the Business Entity Connector.

referenceId

string

 

The Business Entity Connector reference identifier.


 

List-Business-Entity-TypesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

The identifier of the Business Entity Type.

name

string

 

The Business Entity Type name.

description

string

 

The description of the Business Entity Type.

provider

Provider

 

provider

 

Provider

Summary:

Description: provider

 

          Properties:

Name

Type

Summary

referenceId

string

 

The reference identifier of the Business Entity Connector.

externalType

string

 

The type that is used to identify the Business Entity Type in an external system.

externalIdField

string

 

Represents the field that is used in the external system to identify a Business Entity.

 


 

List-Content-CategoriesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

The Content Category identifier.

name

string

 

The name of the Content Category.


 

List-Storage-ConnectorsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

The identifier of the Storage Connector.

name

string

 

The name of the Storage Connector.

providerType

string

 

The type of the Storage Connector.

referenceId

string

 

The Storage Connector reference identifier.


 

Store-ContentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

assets

Assets

 

assets

category

string

 

The Content Category that the content will be stored in.

storageProviderReferenceId

string

 

Leave blank for automatic storage selection using storage rules.

connections

Connections

 

connections

userProperties

UserProperties

 

 

 

Assets

Summary:

Description: assets

 

          Properties:

Name

Type

Summary

title

string

 

The title of the content item that is being stored.

assetType

string

 

The type of the asset that is provided.  Values: [BinaryContent, UriLink, BinaryLink]

content

string(byte)

 

The URL or binary contents that are being stored.

fileName

string

 

The name of the file that is being stored.

contentType

string

 

The mime-type of the content to store.

 

Connections

Summary:

Description: connections

 

          Properties:

Name

Type

Summary

providerReferenceId

string

 

The identifier that uniquely identifies the business entity connector.

externalType

string

 

The type of the business entity to be stored.

externalId

string

 

The identifier that uniquely identifies the business entity.

 


 

UserProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary