Console
    Start free

    Method: projects.locations.collectApiData

    Collect API data from a source and push it to Hub's collect layer.

    HTTP request

    POST https://apihub.googleapis.com/v1/{location=projects/*/locations/*}:collectApiData

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    location

    string

    Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}

    Request body

    The request body contains data with the following structure:

    JSON representation 
     { 
 "collectionType" 
 : 
 enum (  CollectionType 
 
) 
 , 
 "pluginInstance" 
 : 
 string 
 , 
 "actionId" 
 : 
 string 
 , 
 "apiData" 
 : 
 { 
 object (  ApiData 
 
) 
 } 
 }
    Fields
    collectionType

    enum ( CollectionType )

    Required. The type of collection. Applies to all entries in apiData .
    pluginInstance

    string

    Required. The plugin instance collecting the API data. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance} .
    actionId

    string

    Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.
    apiData

    object ( ApiData )

    Required. The API data to be collected.

    Response body

    If successful, the response body contains an instance of Operation .

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    CollectionType

    The type of the collect request.

    Enums
    COLLECTION_TYPE_UNSPECIFIED The default value. This value is used if the collection type is omitted.
    COLLECTION_TYPE_UPSERT The collection type is upsert. This should be used when an API is created or updated at the source.
    COLLECTION_TYPE_DELETE The collection type is delete. This should be used when an API is deleted at the source.

    ApiData

    The API data to be collected.

    JSON representation 
     { 
 // Union field Data 
can be only one of the following: 
 "apiMetadataList" 
 : 
 { 
 object (  ApiMetadataList 
 
) 
 } 
 // End of list of possible types for union field Data 
. 
 }
    Fields
    Union field Data . The data to be collected. Data can be only one of the following:
    apiMetadataList

    object ( ApiMetadataList )

    Optional. The list of API metadata.

    ApiMetadataList

    The message to hold repeated API metadata.

    JSON representation 
     { 
 "apiMetadata" 
 : 
 [ 
 { 
 object (  APIMetadata 
 
) 
 } 
 ] 
 }
    Fields
    apiMetadata[]

    object ( APIMetadata )

    Required. The list of API metadata.

    APIMetadata

    The API metadata.

    JSON representation 
     { 
 "api" 
 : 
 { 
 object (  Api 
 
) 
 } 
 , 
 "versions" 
 : 
 [ 
 { 
 object (  VersionMetadata 
 
) 
 } 
 ] 
 , 
 "originalId" 
 : 
 string 
 , 
 "originalCreateTime" 
 : 
 string 
 , 
 "originalUpdateTime" 
 : 
 string 
 }
    Fields
    api

    object ( Api )

    Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems.
    versions[]

    object ( VersionMetadata )

    Optional. The list of versions present in an API resource.
    originalId

    string

    Optional. The unique identifier of the API in the system where it was originally created.
    originalCreateTime

    string ( Timestamp format)

    Optional. Timestamp indicating when the API was created at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    originalUpdateTime

    string ( Timestamp format)

    Required. Timestamp indicating when the API was last updated at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    VersionMetadata

    The metadata associated with a version of the API resource.

    JSON representation 
     { 
 "version" 
 : 
 { 
 object (  Version 
 
) 
 } 
 , 
 "specs" 
 : 
 [ 
 { 
 object (  SpecMetadata 
 
) 
 } 
 ] 
 , 
 "deployments" 
 : 
 [ 
 { 
 object (  DeploymentMetadata 
 
) 
 } 
 ] 
 , 
 "originalId" 
 : 
 string 
 , 
 "originalCreateTime" 
 : 
 string 
 , 
 "originalUpdateTime" 
 : 
 string 
 }
    Fields
    version

    object ( Version )

    Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub.
    specs[]

    object ( SpecMetadata )

    Optional. The specs associated with this version. Note that an API version can be associated with multiple specs.
    deployments[]

    object ( DeploymentMetadata )

    Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.)
    originalId

    string

    Optional. The unique identifier of the version in the system where it was originally created.
    originalCreateTime

    string ( Timestamp format)

    Optional. Timestamp indicating when the version was created at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    originalUpdateTime

    string ( Timestamp format)

    Required. Timestamp indicating when the version was last updated at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    SpecMetadata

    The metadata associated with a spec of the API version.

    JSON representation 
     { 
 "spec" 
 : 
 { 
 object (  Spec 
 
) 
 } 
 , 
 "originalId" 
 : 
 string 
 , 
 "originalCreateTime" 
 : 
 string 
 , 
 "originalUpdateTime" 
 : 
 string 
 }
    Fields
    spec

    object ( Spec )

    Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub.
    originalId

    string

    Optional. The unique identifier of the spec in the system where it was originally created.
    originalCreateTime

    string ( Timestamp format)

    Optional. Timestamp indicating when the spec was created at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    originalUpdateTime

    string ( Timestamp format)

    Required. Timestamp indicating when the spec was last updated at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    DeploymentMetadata

    The metadata associated with a deployment.

    JSON representation 
     { 
 "deployment" 
 : 
 { 
 object (  Deployment 
 
) 
 } 
 , 
 "originalId" 
 : 
 string 
 , 
 "originalCreateTime" 
 : 
 string 
 , 
 "originalUpdateTime" 
 : 
 string 
 }
    Fields
    deployment

    object ( Deployment )

    Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub.
    originalId

    string

    Optional. The unique identifier of the deployment in the system where it was originally created.
    originalCreateTime

    string ( Timestamp format)

    Optional. Timestamp indicating when the deployment was created at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    originalUpdateTime

    string ( Timestamp format)

    Required. Timestamp indicating when the deployment was last updated at the source.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: