Os recursos na API do reator são frequentemente relacionados entre si. Este documento fornece uma visão geral de como as relações de recursos são estabelecidas na API e os requisitos de relação de cada tipo de recurso.
Dependendo do tipo de recurso em questão, algumas relações são necessárias. Um relacionamento necessário implica que o recurso pai não pode existir sem o relacionamento. Todas as outras relações são opcionais.
Independentemente de serem obrigatórias ou opcionais, as relações são estabelecidas automaticamente pelo sistema quando os recursos relevantes são criados ou devem ser criadas manualmente. No caso de criar relações manualmente, há dois métodos possíveis dependendo do recurso em questão:
Consulte a seção requisitos de relacionamento para obter uma lista de relacionamentos compatíveis com cada tipo de recurso e os métodos necessários para estabelecer esses relacionamentos, quando aplicável.
Criar uma relação por carga
Algumas relações devem ser estabelecidas manualmente ao criar inicialmente um recurso. Para fazer isso, você deve fornecer um objeto relationship na carga da solicitação ao criar o recurso pai pela primeira vez. Exemplos dessas relações:
Um objeto que deve ser fornecido ao criar relações por carga. Cada chave nesse objeto representa um tipo de relacionamento específico. No exemplo acima, são estabelecidos os relacionamentos extension e rules, que são específicos a rule_components. Para obter mais informações sobre tipos de relacionamentos compatíveis com recursos diferentes, consulte a seção sobre requisitos de relacionamento por recurso.
data
Cada tipo de relação fornecido no objeto relationship deve conter uma propriedade data, que faz referência a id e type do recurso com o qual uma relação está sendo estabelecida. Você pode criar uma relação com vários recursos do mesmo tipo formatando a propriedade data como uma matriz de objetos, com cada objeto contendo os id e type de um recurso aplicável.
id
O identificador exclusivo de um recurso. Cada id deve ser acompanhado por uma propriedade irmã type, indicando o tipo de recurso em questão.
type
O tipo de recurso conforme referenciado por um campo id irmão. Os valores aceitos são data_elements, rules, extensions e environments.
Criar uma relação por URL
Ao contrário de outros recursos, as bibliotecas estabelecem relações por meio de seus próprios pontos de extremidade dedicados /relationship. São exemplos:
Um objeto que faz referência ao id e type do recurso do target para o relacionamento. Se você estiver criando uma relação com vários recursos do mesmo tipo (como extensions e rules), a propriedade data deverá ser formatada como uma matriz de objetos, com cada objeto contendo os id e type de um recurso aplicável.
id
O identificador exclusivo de um recurso. Cada id deve ser acompanhado por uma propriedade irmã type, indicando o tipo de recurso em questão.
type
O tipo de recurso conforme referenciado por um campo id irmão. Os valores aceitos são data_elements, rules, extensions e environments.
Requisitos de relação por recurso
As tabelas a seguir descrevem as relações disponíveis para cada tipo de recurso, sejam essas relações necessárias ou não, e o método aceito para criar manualmente a relação, onde aplicável.
OBSERVAÇÃO
Se uma relação não estiver listada como sendo criada por carga ou URL, ela será automaticamente atribuída pelo sistema.