For the complete documentation index, see llms.txt. This page is also available as Markdown.

Act Relationship

Used to link two or more acts together

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Body
anyOptional
Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/_export

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional
Query parameters
negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/{id}/_export

Perform a search (query) for

get

The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_offsetnumberOptional

The offet of the first result to return

_countnumberOptional

The count of items to return in this result set

_includeTotalbooleanOptional

True if the server should count the matching results. May reduce performance

_orderBystringOptional

Instructs the result set to be ordered (in format: property:(asc|desc))

_queryIdstringOptional

The query state identifier. This allows the client to get a stable result set.

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship

Creates the resource. If the resource already exists, then a 409 is thrown

post

This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/ActRelationship

Returns specific options for a single resource

options
Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

options/ActRelationship

Perform a search (query) and return only the headers

head

The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change

Query parameters
negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
204

There is not response for this method

No content

head/ActRelationship

No content

Retrieves the current version of the specified resource

get

This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object which should be retrieved

Query parameters
_bundlebooleanOptional

True if the server should send related objects to the caller in a bundle

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/{id}

Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does

post

This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be created or updated

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/ActRelationship/{id}

Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown

put

This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.

         Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be updated

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

put/ActRelationship/{id}

Deletes the specified resource from the server

delete

This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be deleted

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

delete/ActRelationship/{id}

Retrieves only the metadata of the specified resource

head

The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.

Path parameters
idstringOptional

The identifier of the resource to be retrieved

Query parameters
negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
204

There is not response for this method

No content

head/ActRelationship/{id}

No content

Updates the specified resource according to the instructions in the PATCH file

patch

The PATCH operation allows for partial updating of a resource.

         This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.
        
         The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be patched

Body

Represents a series of patch instructions

versionstringOptional

Gets or sets the version of the patch file

appliesToanyOptional

Application version

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
204

There is not response for this method

No content

patch/ActRelationship/{id}

No content

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/{id}/$diff

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/{id}/$tag

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/{id}/$validate

Gets the specified barcode for the resource

get

This method returns a barcode which explicitly points at the specified resource in the specified authority.

         The barcode is generated using the server's configuration, and is signed by the server's signing key.
        
         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource for which a VRP should be generated

Query parameters
_formatstringOptional

The format of the barcode (santedb-vrp, code39, etc.)

negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/{id}/_code

Gets the digitally signed pointer (in JWS format) for the resource

get

This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return the structured contents of that code so the client can best determine how to represent the data.

         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object for which the pointer should be created

Query parameters
negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Used to link two or more acts together

negationIndbooleanOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstring · uuidOptional

Association type key

targetstring · uuidOptional

The target of the association

relationshipTypestring · uuidOptional

Association type key

sequencenumber · int64Optional
modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/{id}/_ptr

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/$xsd-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/$schema-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/$validate

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/ActRelationship/$xref-use

Performs a linked or chained search on a sub-property

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_offsetnumberOptional

The offet of the first result to return

_countnumberOptional

The count of items to return in this result set

_includeTotalbooleanOptional

True if the server should count the matching results. May reduce performance

_orderBystringOptional

Instructs the result set to be ordered (in format: property:(asc|desc))

_queryIdstringOptional

The query state identifier. This allows the client to get a stable result set.

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a relationship validation rule between two

modifiedOnstring · dateOptional

Gets the time that the validation rule was modified on

sourceClassstring · uuidOptional

Gets the classification key of the source object to which this classification applies

targetClassstring · uuidOptional

Get the target class key

relationshipTypestring · uuidOptional

Gets the relationship type between the

appliesTostringOptional

Gets or sets the application class for XML

descriptionstringOptional

Gets the description for the validation

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/_relationshipRule

Performs a linked or chained search on a sub-property

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
childResourceKeystringOptional

The key of the sub-item to fetch

Query parameters
_bundlebooleanOptional

True if the server should include related objects

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

negationIndstringOptional

A negation indicator - used to flag this relationship as negated

externIdstringOptional

Gets or sets the external key for the object

classificationstringOptional

Association type key

targetstringOptional

The target of the association

relationshipTypestringOptional

Association type key

sequencestringOptional
effectiveVersionSequencestringOptional

Gets or sets the version sequence of the source object when this assoication became active

obsoleteVersionSequencestringOptional

Gets or sets the sequence identifier of the source when this association is no longer active

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses
200

Operation was completed successfully

Represents a relationship validation rule between two

modifiedOnstring · dateOptional

Gets the time that the validation rule was modified on

sourceClassstring · uuidOptional

Gets the classification key of the source object to which this classification applies

targetClassstring · uuidOptional

Get the target class key

relationshipTypestring · uuidOptional

Gets the relationship type between the

appliesTostringOptional

Gets or sets the application class for XML

descriptionstringOptional

Gets the description for the validation

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/ActRelationship/_relationshipRule/{childResourceKey}

Removes a child resource instance from the parent container

delete

This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
childResourceKeystringOptional

The actual value of the sub-key

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Responses
200

Operation was completed successfully

Represents a relationship validation rule between two

modifiedOnstring · dateOptional

Gets the time that the validation rule was modified on

sourceClassstring · uuidOptional

Gets the classification key of the source object to which this classification applies

targetClassstring · uuidOptional

Get the target class key

relationshipTypestring · uuidOptional

Gets the relationship type between the

appliesTostringOptional

Gets or sets the application class for XML

descriptionstringOptional

Gets the description for the validation

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

delete/ActRelationship/_relationshipRule/{childResourceKey}

Last updated

Was this helpful?