Package io.apicurio.registry.rest.v3

Interface IdsResource

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

  • Method Details

    • getContentByGlobalId

      @Path("/globalIds/{globalId}") @GET @Produces("*/*") jakarta.ws.rs.core.Response getContentByGlobalId(@PathParam("globalId") long globalId, @QueryParam("references") HandleReferencesType references)

      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)

    • referencesByContentId

      @Path("/contentIds/{contentId}/references") @GET @Produces("application/json") List<ArtifactReference> referencesByContentId(@PathParam("contentId") long contentId)

      Returns a list containing all the artifact references using the artifact content ID.

      This operation may fail for one of the following reasons:

      • A server error occurred (HTTP error 500)

    • referencesByGlobalId

      @Path("/globalIds/{globalId}/references") @GET @Produces("application/json") List<ArtifactReference> referencesByGlobalId(@PathParam("globalId") long globalId, @QueryParam("refType") ReferenceType refType)

      Returns a list containing all the artifact references using the artifact global ID.

      This operation may fail for one of the following reasons:

      • A server error occurred (HTTP error 500)

    • referencesByContentHash

      @Path("/contentHashes/{contentHash}/references") @GET @Produces("application/json") List<ArtifactReference> referencesByContentHash(@PathParam("contentHash") String contentHash)

      Returns a list containing all the artifact references using the artifact content hash.

      This operation may fail for one of the following reasons:

      • A server error occurred (HTTP error 500)

    • getContentByHash

      @Path("/contentHashes/{contentHash}") @GET @Produces("*/*") jakarta.ws.rs.core.Response getContentByHash(@PathParam("contentHash") String contentHash)

      Gets the content for an artifact version in the registry using the SHA-256 hash of the content. This content hash may be shared by multiple artifact versions in the case where the artifact versions have identical content.

      This operation may fail for one of the following reasons:

      • No content with this contentHash exists (HTTP error 404)
      • A server error occurred (HTTP error 500)

    • getContentById

      @Path("/contentIds/{contentId}") @GET @Produces("*/*") jakarta.ws.rs.core.Response getContentById(@PathParam("contentId") long contentId)

      Gets the content for an artifact version in the registry using the unique content identifier for that content. This content ID may be shared by multiple artifact versions in the case where the artifact versions are identical.

      This operation may fail for one of the following reasons:

      • No content with this contentId exists (HTTP error 404)
      • A server error occurred (HTTP error 500)