3.8.2. Get extensions providing service API

Description

Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.

Parameters


Type	Name	Description	Schema
Query	artifactId required	The artifactId of the bundle containing the service API class	string
Query	className required	The name of the service API class	string
Query	groupId required	The groupId of the bundle containing the service API class	string
Query	version required	The version of the bundle containing the service API class	string

Responses


HTTP Code	Description	Schema
200	successful operation	ExtensionMetadataContainer
400	NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.	No Content
401	Client could not be authenticated.	No Content
403	Client is not authorized to make this request.	No Content
404	The specified resource could not be found.	No Content
409	NiFi Registry was unable to complete the request because it assumes a server state that is not valid.	No Content

Consumes

/

Produces

application/json

Security


Type	Name
apiKey	Authorization

Example HTTP request

Request path


/extensions/provided-service-api

Request query


         {
  "artifactId" : "string",
  "className" : "string",
  "groupId" : "string",
  "version" : "string"
}

Example HTTP response

Response 200


         {
  "numResults" : 0,
  "filterParams" : {
    "bundleType" : "string",
    "extensionType" : "string",
    "tags" : [ "string" ]
  },
  "extensions" : [ {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "name" : "string",
    "displayName" : "string",
    "type" : "string",
    "description" : "string",
    "deprecationNotice" : {
      "reason" : "string",
      "alternatives" : [ "string" ]
    },
    "tags" : [ "string" ],
    "restricted" : {
      "generalRestrictionExplanation" : "string",
      "restrictions" : [ {
        "requiredPermission" : "string",
        "explanation" : "string"
      } ]
    },
    "providedServiceAPIs" : [ {
      "className" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    } ],
    "bundleInfo" : {
      "bucketId" : "string",
      "bucketName" : "string",
      "bundleId" : "string",
      "bundleType" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string",
      "systemApiVersion" : "string"
    },
    "hasAdditionalDetails" : true,
    "linkDocs" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    }
  } ]
}