APapicurio
Artifacts

List artifacts in group

Changed on

Returns a list of all artifacts in the group. This list is paged.

get/groups/{groupId}/artifacts

Request

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

Query parameters

limitinteger

The number of artifacts to return. Defaults to 20.

offsetinteger

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

order'asc' | 'desc'

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

orderby'name' | 'createdOn'

The field to sort by. Can be one of:

  • name
  • createdOn

Response

On a successful response, returns a bounded set of artifacts.

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

  • v2e26e4a280eb6Revision changes
    • info

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