APapicurio
Search
Artifacts

Search for artifacts

Changed on

Returns a paginated list of all artifacts that match the provided filter criteria.

get/search/artifacts

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

namestring

Filter by artifact name.

offsetinteger

The number of artifacts to skip before starting to collect the result set. Defaults to 0.

limitinteger

The number of artifacts to return. Defaults to 20.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'name' | 'createdOn'

The field to sort by. Can be one of:

  • name
  • createdOn
labelsstring[]

Filter by label. Include one or more label to only return artifacts containing all of the specified labels.

propertiesstring[]

Filter by one or more name/value property. Separate each name/value pair using a colon. For example properties=foo:bar will return only artifacts with a custom property named foo and value bar.

descriptionstring

Filter by description.

groupstring

Filter by artifact group.

globalIdinteger

Filter by globalId.

contentIdinteger

Filter by contentId.

Response

On a successful response, returns a result set of artifacts - one for each artifact in the registry that matches the criteria.

countinteger required

The total number of artifacts that matched the query that produced the result set (may be more than the number of artifacts in the result set).

Example response

{
  "artifacts": [
    {
      "groupId": "My-Group",
      "id": "Procurement-Invoice",
      "name": "Artifact Name",
      "description": "Description of the artifact",
      "labels": [
        "current",
        "internal"
      ],
      "type": "AVRO",
      "state": "ENABLED",
      "createdBy": "user1",
      "createdOn": "2019-03-22T12:51:19Z"
    }
  ]
}

Changes

  • v229b79a1c2c74Revision changes
    • info

      removed the ASYNCAPI enum value from the // response property for the response status

    • info

      removed the AVRO enum value from the // response property for the response status

    • info

      removed the GRAPHQL enum value from the // response property for the response status

    • info

      removed the JSON enum value from the // response property for the response status

    • info

      removed the KCONNECT enum value from the // response property for the response status

    • info

      removed the OPENAPI enum value from the // response property for the response status

    • info

      removed the PROTOBUF enum value from the // response property for the response status

    • info

      removed the WSDL enum value from the // response property for the response status

    • info

      removed the XML enum value from the // response property for the response status

    • info

      removed the XSD enum value from the // response property for the response status

  • v2dbd4a1f26836Revision changes
    • info

      added the new optional query request parameter contentId

    • info

      added the new optional query request parameter globalId