Entities

Create a relation between entities

post/api/v1/entities/{id}/members

Request

  • Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /sandbox/api/v1/entities/{id}/members
  • Auth: OAuth 2 (authorization code, authorization URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token; client credentials, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token, scopes: policy.write)

Path parameters

idstring required

e.g. entity_c0645dc026a74ae99ec436df63d77d2c

Request body

targetEntityIdstring nullable

e.g. entity_c0645dc026a74ae99ec436df63d77d2c

rolestring nullable

The nature of the relationship between the parent entity and the target entity.

memostring nullable

An optional memo or note that provides additional context about the relationship.

Response

OK

datastring nullable

e.g. relation_c0645dc026a74ae99ec436df63d77d2c

successboolean
reasonstring nullable
resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.