Skip to content

Latest commit

 

History

History
443 lines (281 loc) · 16.8 KB

DefinedInterfaceBehaviorsApi.md

File metadata and controls

443 lines (281 loc) · 16.8 KB

\DefinedInterfaceBehaviorsApi

All URIs are relative to https://localhost/cloudapi

Method HTTP request Description
AddDefinedEntityTypeAccess Post /1.0.0/entityTypes/{id}/behaviorAccessControls Adds an access control configuration of an entity type's behavior
AddInterfaceBehavior Post /1.0.0/interfaces/{id}/behaviors Add a new interface Behavior if the Interface is not in use
DeleteInterfaceBehavior Delete /1.0.0/interfaces/{id}/behaviors/{behaviorId} Remove a Behavior from the Defined Interface.
GetDefinedEntityTypeAccess Get /1.0.0/entityTypes/{id}/behaviorAccessControls Gets the access control configuration of the entity type's behaviors
GetDefinedEntityTypeBehaviors Get /1.0.0/entityTypes/{id}/behaviors Get the Behaviors of the Defined Entity Type.
GetInterfaceBehavior Get /1.0.0/interfaces/{id}/behaviors/{behaviorId} Get a Behavior in the Defined Interface.
GetInterfaceBehaviors Get /1.0.0/interfaces/{id}/behaviors Get the Behaviors of the Defined Interface.
GetTypeBehavior Get /1.0.0/entityTypes/{id}/behaviors/{behaviorId} Get a Behavior in the Defined Type
InvokeDefinedEntityBehavior Post /1.0.0/entities/{id}/behaviors/{behaviorId}/invocations Invokes a behavior on a defined entity
RemoveBehaviorOverride Delete /1.0.0/entityTypes/{id}/behaviors/{behaviorId} Remove a Behavior override from the Defined Entity Type.
SetDefinedEntityTypeAccess Put /1.0.0/entityTypes/{id}/behaviorAccessControls Sets the access control configuration of the entity type's behaviors
UpdateInterfaceBehavior Put /1.0.0/interfaces/{id}/behaviors/{behaviorId} Update the execution of the specified Behavior in the Defined Interface
UpdateInterfaceBehaviors Put /1.0.0/interfaces/{id}/behaviors Update all the executions of the specified Behaviors (possibly removing or adding some)
UpdateTypeBehavior Put /1.0.0/entityTypes/{id}/behaviors/{behaviorId} Update the execution of the specified Behavior in the Defined Entity Type

AddDefinedEntityTypeAccess

BehaviorAccess AddDefinedEntityTypeAccess(ctx, definition, id) Adds an access control configuration of an entity type's behavior

Adds an access control configuration of an entity type's behavior

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
definition BehaviorAccess
id string

Return type

BehaviorAccess

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddInterfaceBehavior

Behavior AddInterfaceBehavior(ctx, behavior, id) Add a new interface Behavior if the Interface is not in use

Add a new Behavior to the Interface. Only allowed if the Interface is not in use.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
behavior Behavior
id string

Return type

Behavior

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteInterfaceBehavior

DeleteInterfaceBehavior(ctx, id, behaviorId) Remove a Behavior from the Defined Interface.

Remove a Behavior from the Defined Interface. The Behaviors can be specified by ID or by name.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
behaviorId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDefinedEntityTypeAccess

BehaviorAccesses GetDefinedEntityTypeAccess(ctx, page, pageSize, id) Gets the access control configuration of the entity type's behaviors

Gets the access control configuration of the entity type's behaviors

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
page int32 Page to fetch, zero offset. [default to 1]
pageSize int32 Results per page to fetch. [default to 25]
id string

Return type

BehaviorAccesses

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDefinedEntityTypeBehaviors

Behaviors GetDefinedEntityTypeBehaviors(ctx, page, pageSize, id) Get the Behaviors of the Defined Entity Type.

Retrieve the Behaviors of the specified Defined Entity Type.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
page int32 Page to fetch, zero offset. [default to 1]
pageSize int32 Results per page to fetch. [default to 25]
id string

Return type

Behaviors

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInterfaceBehavior

Behavior GetInterfaceBehavior(ctx, id, behaviorId) Get a Behavior in the Defined Interface.

Retrieve a specific Behavior in the specified Defined Interface.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
behaviorId string

Return type

Behavior

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInterfaceBehaviors

Behaviors GetInterfaceBehaviors(ctx, page, pageSize, id) Get the Behaviors of the Defined Interface.

Retrieve the Behaviors of the specified Defined Interface.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
page int32 Page to fetch, zero offset. [default to 1]
pageSize int32 Results per page to fetch. [default to 25]
id string

Return type

Behaviors

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTypeBehavior

Behavior GetTypeBehavior(ctx, id, behaviorId) Get a Behavior in the Defined Type

Retrieve a specific Behavior in the Defined Type. The Behavior must be specified by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
behaviorId string

Return type

Behavior

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InvokeDefinedEntityBehavior

InvokeDefinedEntityBehavior(ctx, id, behaviorId, optional) Invokes a behavior on a defined entity

Invokes a behavior on a defined entity. The contract of the behavior is specified in the behavior description. If an Activity behavior is invoked with an 'operationId' in the invocation metadata, then another invocation of the behavior with the same 'operationId' will be ignored within the next 1 hour.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
behaviorId string
optional *DefinedInterfaceBehaviorsApiInvokeDefinedEntityBehaviorOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefinedInterfaceBehaviorsApiInvokeDefinedEntityBehaviorOpts struct

Name Type Description Notes

invocation | optional.Interface of BehaviorInvocation| |

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveBehaviorOverride

RemoveBehaviorOverride(ctx, id, behaviorId) Remove a Behavior override from the Defined Entity Type.

Remove a Behavior override in the Defined Entity Type. The Behavior must be specified by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
behaviorId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetDefinedEntityTypeAccess

BehaviorAccesses SetDefinedEntityTypeAccess(ctx, definition, id) Sets the access control configuration of the entity type's behaviors

Sets the access control configuration of the entity type's behaviors

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
definition BehaviorAccesses
id string

Return type

BehaviorAccesses

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateInterfaceBehavior

Behavior UpdateInterfaceBehavior(ctx, behavior, id, behaviorId) Update the execution of the specified Behavior in the Defined Interface

Update the execution of the specified Behavior in the Defined Interface. The Behaviors can be specified by ID or by name.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
behavior Behavior
id string
behaviorId string

Return type

Behavior

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateInterfaceBehaviors

Behaviors UpdateInterfaceBehaviors(ctx, behaviors, id) Update all the executions of the specified Behaviors (possibly removing or adding some)

Update all Behaviors, possibly adding or removing some if the Interface is not in use. If the Interface is in use, then only the executions of the existing Behaviors can be updated. The Behaviors can be specified by ID or by name.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
behaviors Behaviors
id string

Return type

Behaviors

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTypeBehavior

Behavior UpdateTypeBehavior(ctx, behavior, id, behaviorId) Update the execution of the specified Behavior in the Defined Entity Type

Override the execution of the specified Behavior in the Defined Entity Type. The Behavior must be specified by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
behavior Behavior
id string
behaviorId string

Return type

Behavior

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]