Skip to content

Resources API

Os endpoints Resources gerem delivery resources e o fluxo de external setup.

GET /api/v2/resources

Devolve resources.

Argumentos:

ArgumentoLocalizaçãoDescrição
workspaceQueryFiltro opcional por workspace fullname.
projectQueryFiltro opcional por project fullname.

Payload: nenhum.

Resposta: ResourceView[].

GET /api/v2/resources/:fullname

Devolve um resource.

Argumentos:

ArgumentoLocalizaçãoDescrição
fullnamePathResource fullname.

Payload: nenhum.

Resposta: ResourceView.

PUT /api/v2/resources/:fullname

Cria ou atualiza um resource.

Argumentos:

ArgumentoLocalizaçãoDescrição
fullnamePathResource fullname. Deve coincidir com payload.fullname.

Payload:

CampoObrigatórioDescrição
nameSimNome do resource.
fullnameSimResource fullname.
workspaceSimWorkspace fullname.
projectNãoProject fullname, se o resource estiver vinculado a um project.
blueprintSimBlueprint fullname que define o comportamento setup/action.
dataNãoDados específicos do resource.
tagsNãoTags.
labelsNãoLabels.
meta.titleNãoTítulo visível.

Resposta: ResourceView.

DELETE /api/v2/resources/:fullname

Elimina um resource.

Argumentos:

ArgumentoLocalizaçãoDescrição
fullnamePathResource fullname.

Payload: nenhum.

Resposta: OperationResult.

GET /api/v2/resources/external/:token

Abre external resource setup por token.

Argumentos:

ArgumentoLocalizaçãoDescrição
tokenPathToken de external setup.

Payload: nenhum.

Resposta: ExternalResourceView.

POST /api/v2/resources/external/:token

Envia payload para external resource setup.

Argumentos:

ArgumentoLocalizaçãoDescrição
tokenPathToken de external setup.

Payload:

CampoObrigatórioDescrição
transformSimObjeto ou null, resultado transform/setup específico do resource/app.

Resposta: OperationResult.