collections

Listar modelos de coleta

Os modelos vigentes que a organizacao enxerga (os dela e os modelos GYRA+), com metricas de uso, dos mais usados para os menos usados. Cada um diz o que sera pedido. Pagina padrao de 50, maximo 100.

Para montar um seletor, use enabled=true: modelo desligado continua na listagem sem o filtro.

O slug daqui e o que entra em create_collection. Chame esta tool primeiro: criar solicitacao com slug inventado falha.

get/v1/collection-templates

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/collection-templates
  • Auth: HTTP bearer

Query parameters

searchstring

Casa por nome ou pela chave, sem acento e sem caixa.

scope'ORGANIZATION' | 'SYSTEM'

ORGANIZATION (modelos da sua organizacao) ou SYSTEM (modelos GYRA+). Sem o parametro, os dois.

enabledboolean

true devolve so os modelos ligados. Sem o parametro (ou com false), ligados e desligados.

itemKindstring[]

So modelos que pedem itens destes tipos (DOCUMENT, FORM, SIGNATURE, CONSENT, IDENTITY, CUSTOM). Repita para varios.

skipnumber
takenumber

Response

Modelos com slug, nome, descricao, itens e uso.

totalinteger

Changes

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