Skip to main content

CustomAPI

  • Namespace: PPDS.Dataverse.Generated
  • Assembly: PPDS.Dataverse
  • Kind: Class
  • Base: Entity
  • Implements: INotifyPropertyChanged, INotifyPropertyChanging, IExtensibleDataObject

Summary​

Entity that defines a custom API

Members​

Constructors​

CustomAPI()​

CustomAPI()

Default Constructor.

Properties​

AllowedCustomProcessingStepType​

Nullable<customapi_allowedcustomprocessingsteptype> AllowedCustomProcessingStepType { get; set; }

The type of custom processing step allowed

BindingType​

Nullable<customapi_bindingtype> BindingType { get; set; }

The binding type of the custom API

BoundEntityLogicalName​

string BoundEntityLogicalName { get; set; }

The logical name of the entity bound to the custom API

ComponentIdUnique​

Nullable<Guid> ComponentIdUnique { get; }

For internal use only.

ComponentState​

Nullable<componentstate> ComponentState { get; }

For internal use only.

CreatedBy​

EntityReference CreatedBy { get; }

Unique identifier of the user who created the record.

CreatedOn​

Nullable<DateTime> CreatedOn { get; }

Date and time when the record was created.

CreatedOnBehalfBy​

EntityReference CreatedOnBehalfBy { get; }

Unique identifier of the delegate user who created the record.

CustomAPIId​

Nullable<Guid> CustomAPIId { get; set; }

Unique identifier for custom API instances

Description​

string Description { get; set; }

Localized description for custom API instances

DisplayName​

string DisplayName { get; set; }

Localized display name for custom API instances

ExecutePrivilegeName​

string ExecutePrivilegeName { get; set; }

Name of the privilege that allows execution of the custom API

FxExpressionId​

EntityReference FxExpressionId { get; set; }

Unique identifier for fxexpression associated with Custom API.

ImportSequenceNumber​

Nullable<int> ImportSequenceNumber { get; set; }

Sequence number of the import that created this record.

IsCustomizable​

BooleanManagedProperty IsCustomizable { get; set; }

For internal use only.

IsFunction​

Nullable<bool> IsFunction { get; set; }

Indicates if the custom API is a function (GET is supported) or not (POST is supported)

IsManaged​

Nullable<bool> IsManaged { get; }

Indicates whether the solution component is part of a managed solution.

IsPrivate​

Nullable<bool> IsPrivate { get; set; }

Indicates if the custom API is private (hidden from metadata and documentation)

ModifiedBy​

EntityReference ModifiedBy { get; }

Unique identifier of the user who modified the record.

ModifiedOn​

Nullable<DateTime> ModifiedOn { get; }

Date and time when the record was modified.

ModifiedOnBehalfBy​

EntityReference ModifiedOnBehalfBy { get; }

Unique identifier of the delegate user who modified the record.

Name​

string Name { get; set; }

The primary name of the custom API

OverriddenCreatedOn​

Nullable<DateTime> OverriddenCreatedOn { get; set; }

Date and time that the record was migrated.

OverwriteTime​

Nullable<DateTime> OverwriteTime { get; }

For internal use only.

OwnerId​

EntityReference OwnerId { get; set; }

Owner Id

OwningBusinessUnit​

EntityReference OwningBusinessUnit { get; }

Unique identifier for the business unit that owns the record

OwningTeam​

EntityReference OwningTeam { get; }

Unique identifier for the team that owns the record.

OwningUser​

EntityReference OwningUser { get; }

Unique identifier for the user that owns the record.

PowerfxRuleId​

EntityReference PowerfxRuleId { get; set; }

Unique identifier for powerfxrule associated with Custom API.

SolutionId​

Nullable<Guid> SolutionId { get; }

Unique identifier of the associated solution.

TimeZoneRuleVersionNumber​

Nullable<int> TimeZoneRuleVersionNumber { get; set; }

For internal use only.

UTCConversionTimeZoneCode​

Nullable<int> UTCConversionTimeZoneCode { get; set; }

Time zone code that was in use when the record was created.

UniqueName​

string UniqueName { get; set; }

Unique name for the custom API

VersionNumber​

Nullable<long> VersionNumber { get; }

Version Number

WorkflowSdkStepEnabled​

Nullable<bool> WorkflowSdkStepEnabled { get; set; }

Indicates if the custom API is enabled as a workflow action

customapi_customapirequestparameter​

IEnumerable<CustomAPIRequestParameter> customapi_customapirequestparameter { get; set; }

1:N customapi_customapirequestparameter

customapi_customapiresponseproperty​

IEnumerable<CustomAPIResponseProperty> customapi_customapiresponseproperty { get; set; }

1:N customapi_customapiresponseproperty

statecode​

Nullable<customapi_statecode> statecode { get; set; }

Status of the Custom API

statuscode​

Nullable<customapi_statuscode> statuscode { get; set; }

Reason for the status of the Custom API