Package io.apicurio.registry.rest.v1

Interface IdsResource

@Path("/apis/registry/v1/ids") public interface IdsResource
A JAX-RS interface. An implementation of this interface must be provided.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    getArtifactByGlobalId(long globalId)
    Gets the content for an artifact version in the registry using its globally unique identifier.
    ArtifactMetaData
    getArtifactMetaDataByGlobalId(long globalId)
    Gets the metadata for an artifact version in the registry using its globally unique identifier.

  • Method Details

    • getArtifactByGlobalId

      @Path("/{globalId}") @GET @Produces({"application/json","application/x-protobuf","application/x-protobuffer"}) jakarta.ws.rs.core.Response getArtifactByGlobalId(@PathParam("globalId") long globalId)
      Gets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)

    • getArtifactMetaDataByGlobalId

      @Path("/{globalId}/meta") @GET @Produces("application/json") ArtifactMetaData getArtifactMetaDataByGlobalId(@PathParam("globalId") long globalId)
      Gets the metadata for an artifact version in the registry using its globally unique identifier. The returned metadata includes both generated (read-only) and editable metadata (such as name and description). This operation may fail for one of the following reasons: * No artifact version with this `globalId` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)