Class CmsExternalApi

The Object Type 200. This object type specifies system objects for defining access to external RESTful APIs. These can be hosted outside the cluster, e.g. ChatGPT, LanguageTool. An 'External API' definitions carries information about the external endpoint URL and credentials.

Inheritance

object

CmsObject

CmsExternalApi

Inherited Members

CmsObject.Meta

CmsObject.Values

CmsObject.GetValue(int, int, int)

CmsObject.GetValues(int, int, int)

CmsObject.SetValue(CmsValue)

CmsObject.SetValues(int, int, int, IEnumerable<CmsValue>)

CmsObject.GetValue<T>(int, int, int)

CmsObject.SetValue<T>(int, int, int, T)

CmsObject.GetValues<T>(int, int, int)

CmsObject.SetValues<T>(int, int, int, IEnumerable<T>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Noxum.Nova.Cms.Client

Assembly: Noxum.Nova.Cms.Client.dll

Syntax

public class CmsExternalApi : CmsObject

Properties

ExternalApiAcceptSelfSignedCertificates

Get or set value of attribute 20008

Declaration

public bool? ExternalApiAcceptSelfSignedCertificates { get; set; }

Property Value

Type	Description
bool?

ExternalApiAuthenticationHeader

Get or set value of attribute 20003

Declaration

public string ExternalApiAuthenticationHeader { get; set; }

Property Value

Type	Description
string

ExternalApiAuthenticationScheme

Get or set value of attribute 20002

Declaration

public string ExternalApiAuthenticationScheme { get; set; }

Property Value

Type	Description
string

ExternalApiClientCertificate

Get or set value of attribute 20006

Declaration

public string ExternalApiClientCertificate { get; set; }

Property Value

Type	Description
string

ExternalApiEndpointUrl

Get or set value of attribute 20001

Declaration

public string ExternalApiEndpointUrl { get; set; }

Property Value

Type	Description
string

ExternalApiMappedToRazorApi

Get or set value of attribute 20009

Declaration

public bool? ExternalApiMappedToRazorApi { get; set; }

Property Value

Type	Description
bool?

ExternalApiSecret

Get or set value of attribute 20005

Declaration

public string ExternalApiSecret { get; set; }

Property Value

Type	Description
string

ExternalApiTimeout

Get or set value of attribute 20007

Declaration

public long? ExternalApiTimeout { get; set; }

Property Value

Type	Description
long?

ExternalApiUserName

Get or set value of attribute 20004

Declaration

public string ExternalApiUserName { get; set; }

Property Value

Type	Description
string

Methods

GetAttributeDescription(int)

Get value of attribute 1012

Declaration

public string GetAttributeDescription(int language)

Parameters

Type	Name	Description
int	language

Returns

Type	Description
string

GetAttributeName(int)

Get value of attribute 1000

Declaration

public string GetAttributeName(int language)

Parameters

Type	Name	Description
int	language

Returns

Type	Description
string

SetAttributeDescription(int, string)

Set value of attribute 1012

Declaration

public void SetAttributeDescription(int language, string value)

Parameters

Type	Name	Description
int	language
string	value

SetAttributeName(int, string)

Set value of attribute 1000

Declaration

public void SetAttributeName(int language, string value)

Parameters

Type	Name	Description
int	language
string	value