APapicurio
Metadata

Get artifact metadata

Changed on

Gets the metadata for an artifact in the registry, based on the latest version. If the latest version of the artifact is marked as DISABLED, the next available non-disabled version will be used. The returned metadata includes both generated (read-only) and editable metadata (such as name and description).

This operation can fail for the following reasons:

  • No artifact with this artifactId exists or all versions are DISABLED (HTTP error 404)
  • A server error occurred (HTTP error 500)
get/groups/{groupId}/artifacts/{artifactId}/meta

Request

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

Response

The artifact's metadata.

namestring
descriptionstring
createdBystring required
createdOnstring date-time required
modifiedBystring required
modifiedOnstring date-time required
idstring required

The ID of a single artifact.

versionstring required
typestring required
globalIdinteger required
state'ENABLED' | 'DISABLED' | 'DEPRECATED' required

Describes the state of an artifact or artifact version. The following states are possible:

  • ENABLED
  • DISABLED
  • DEPRECATED
labelsstring[]
propertiesProperties

User-defined name-value pairs. Name and value must be strings.

groupIdstring

An ID of a single artifact group.

contentIdinteger required

Example response

{
  "groupId": "My-Group",
  "id": "Procurement-Invoice",
  "name": "Artifact Name",
  "description": "Description of the artifact",
  "type": "AVRO",
  "version": 18,
  "createdBy": "user1",
  "createdOn": "2019-03-22T12:51:19Z",
  "modifiedBy": "user2",
  "modifiedOn": "2019-07-19T15:09:00Z",
  "globalId": 12984719247,
  "contentId": 82736,
  "labels": [
    "label-1",
    "label-2"
  ],
  "properties": {
    "custom-1": "foo",
    "custom-2": "bar"
  },
  "references": [
    {
      "groupId": "mygroup",
      "artifactId": "13842090-2ce3-11ec-8d3d-0242ac130003",
      "version": 2,
      "name": "foo.bar.Open"
    }
  ]
}

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

  • v2c7368363b270Revision changes
    • info

      added the optional property to the response with the status