3.3.13. Exports specified bucket flow version content


GET /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export

Description

Exports the specified version of a flow, including the metadata and content of the flow.

Parameters

Type Name Description Schema

Path

bucketId required

The bucket identifier

string

Path

flowId required

The flow identifier

string

Path

versionNumber required

The version number

integer (int32)

Responses

HTTP Code Description Schema

200

successful operation

4.58. VersionedFlowSnapshot

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

Example HTTP request


/buckets/string/flows/string/versions/0/export

Example HTTP response


         {
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "defaultFlowFileExpiration" : "string",
      "defaultBackPressureObjectThreshold" : 0,
      "defaultBackPressureDataSizeThreshold" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "defaultFlowFileExpiration" : "string",
    "defaultBackPressureObjectThreshold" : 0,
    "defaultBackPressureDataSizeThreshold" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "componentType" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}