Console
    Contact Us Start free

    REST Resource: projects.locations.templates

    Resource: Template

    Defines the template for Application Integration

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "usageInfo" 
 : 
 string 
 , 
 "docLink" 
 : 
 string 
 , 
 "templateBundle" 
 : 
 { 
 object (  TemplateBundle 
 
) 
 } 
 , 
 "components" 
 : 
 [ 
 { 
 object (  Component 
 
) 
 } 
 ] 
 , 
 "tags" 
 : 
 [ 
 string 
 ] 
 , 
 "categories" 
 : 
 [ 
 enum (  Category 
 
) 
 ] 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "author" 
 : 
 string 
 , 
 "usageCount" 
 : 
 string 
 , 
 "lastUsedTime" 
 : 
 string 
 , 
 "visibility" 
 : 
 enum (  Visibility 
 
) 
 , 
 "sharedWith" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    name

    string

    Identifier. Resource name of the template.
    displayName

    string

    Required. The name of the template
    description

    string

    Optional. Description of the template. The length should not be more than 255 characters
    usageInfo

    string

    Optional. Information on how to use the template. This should contain detailed information about usage of the template.
    templateBundle

    object ( TemplateBundle )

    Required. Bundle which is part of the templates. The template entities in the bundle would be converted to an actual entity.
    components[]

    object ( Component )

    Optional. Components being used in the template. This could be used to categorize and filter.
    tags[]

    string

    Required. Tags which are used to identify templates. These tags could be for business use case, connectors etc.
    categories[]

    enum ( Category )

    Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing.
    createTime

    string ( Timestamp format)

    Output only. Auto-generated.

    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" .
    updateTime

    string ( Timestamp format)

    Output only. Auto-generated

    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" .
    author

    string

    Optional. Creator of the template.
    usageCount

    string ( int64 format)

    Optional. Number of template usages.
    lastUsedTime

    string ( Timestamp format)

    Optional. Time the template was last used.

    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" .
    visibility

    enum ( Visibility )

    Required. Visibility of the template.
    sharedWith[]

    string

    Required. Resource names with which the template is shared for example ProjectNumber/Ord id

    TemplateBundle

    Define the bundle of the template.

    JSON representation 
     { 
 "integrationVersionTemplate" 
 : 
 { 
 object (  IntegrationVersionTemplate 
 
) 
 } 
 , 
 "subIntegrationVersionTemplates" 
 : 
 [ 
 { 
 object (  IntegrationVersionTemplate 
 
) 
 } 
 ] 
 }
    Fields
    integrationVersionTemplate

    object ( IntegrationVersionTemplate )

    Required. Main integration templates of the template bundle.
    subIntegrationVersionTemplates[]

    object ( IntegrationVersionTemplate )

    Optional. Sub integration templates which would be added along with main integration.

    IntegrationVersionTemplate

    Define the template of IntegrationVersion.

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "integrationVersion" 
 : 
 { 
 object (  IntegrationVersion 
 
) 
 } 
 }
    Fields
    key

    string

    Required. Unique Key of the IntegrationVersion.
    integrationVersion

    object ( IntegrationVersion )

    Required. Templatized version of integration.

    Component

    Define the components that are present in a template.

    JSON representation 
     { 
 "type" 
 : 
 enum (  Type 
 
) 
 , 
 "name" 
 : 
 string 
 }
    Fields
    type

    enum ( Type )

    Optional. type of the component.
    name

    string

    Optional. name of the component.

    Type

    type of the component.

    Enums
    TYPE_UNSPECIFIED Component type is unspecified
    TRIGGER Trigger component
    TASK Task component
    CONNECTOR Connector component

    Category

    Category of the template.

    Enums
    CATEGORY_UNSPECIFIED Category is unspecified
    AI_MACHINE_LEARNING AI_MACHINE_LEARNING
    BUSINESS_INTELLIGENCE BUSINESS_INTELLIGENCE
    COLLABORATION COLLABORATION
    CUSTOMER_SERVICE CUSTOMER_SERVICE
    DATABASES DATAABASES
    DEVOPS_IT DEVOPS_IT
    CONTENT_AND_FILES CONTENT_AND_FILES
    FINANCE_AND_ACCOUNTING FINANCE_AND_ACCOUNTING
    HUMAN_RESOURCES HUMAN_RESOURCES
    OPERATIONS OPERATIONS
    PRODUCT_PROJECT_MANAGEMENT PRODUCT_PROJECT_MANAGEMENT
    PRODUCTIVITY PRODUCTIVITY
    SALES_AND_MARKETING SALES_AND_MARKETING
    UNIVERSAL_CONNECTORS UNIVERSAL_CONNECTORS
    UTILITY UTILITY
    OTHERS OTHERS

    Visibility

    Visibility of the template.

    Enums
    VISIBILITY_UNSPECIFIED Visibility is unspecified
    PRIVATE Visibility is private
    SHARED Visibility is shared
    PUBLIC Visibility is public

    Methods

    create

    		Creates a new template

    delete

    		Deletes a template

    download

    		Downloads a template.

    get

    		Get a template in the specified project.

    import

    		Import the template to an existing integration.

    list

    		Lists all templates matching the filter.

    patch

    		Updates the template by given id.
    Search templates based on user query and filters.
    Share a template with other clients.

    unshare

    		Unshare a template from given clients.

    upload

    		Uploads a template.

    use

    		Use the template to create integration.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: