{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Personas API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Personas", "type": "folder" }, "items": [ { "info": { "name": "List personas", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of personas returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of personas before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of personas after this cursor" } ] }, "docs": "Get a list of personas. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create a Persona", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/personas", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Persona." }, { "info": { "name": "Update Persona", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/personas", "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update a Persona." }, { "info": { "name": "Get a Persona by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Persona" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a Persona by `name`." }, { "info": { "name": "Delete a Persona by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/personas/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Persona" } ] }, "docs": "Delete a Persona by given `name`." }, { "info": { "name": "Get a persona by id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a persona by `id`." }, { "info": { "name": "Update a Persona", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/personas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing persona with JsonPatch." }, { "info": { "name": "Delete a Persona by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/personas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" } ] }, "docs": "Delete a Persona by given `id`." }, { "info": { "name": "Asynchronously delete a Persona by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/personas/async/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" } ] }, "docs": "Asynchronously delete a Persona by given `id`." }, { "info": { "name": "Get a version of the Persona", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" }, { "name": "version", "value": "", "type": "path", "description": "Personas version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the Persona by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "List Persona versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/personas/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Persona" } ] }, "docs": "Get a list of all the versions of a persona identified by `id`" }, { "info": { "name": "Update a Persona using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/personas/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the Persona" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing persona with JsonPatch." } ] } ], "bundled": true }