Class: TencentCloud::Ess::V20201111::DescribeFileUrlsRequest

Inherits:
Common::AbstractModel
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/v20201111/models.rb

Overview

DescribeFileUrls请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, businesstype = nil, businessids = nil, filename = nil, filetype = nil, offset = nil, limit = nil, urlttl = nil, cctoken = nil, scene = nil, agent = nil) ⇒ DescribeFileUrlsRequest

Returns a new instance of DescribeFileUrlsRequest.



10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
# File 'lib/v20201111/models.rb', line 10198

def initialize(operator=nil, businesstype=nil, businessids=nil, filename=nil, filetype=nil, offset=nil, limit=nil, urlttl=nil, cctoken=nil, scene=nil, agent=nil)
  @Operator = operator
  @BusinessType = businesstype
  @BusinessIds = businessids
  @FileName = filename
  @FileType = filetype
  @Offset = offset
  @Limit = limit
  @UrlTtl = urlttl
  @CcToken = cctoken
  @Scene = scene
  @Agent = agent
end

Instance Attribute Details

#AgentObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def Agent
  @Agent
end

#BusinessIdsObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def BusinessIds
  @BusinessIds
end

#BusinessTypeObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def BusinessType
  @BusinessType
end

#CcTokenObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def CcToken
  @CcToken
end

#FileNameObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def FileName
  @FileName
end

#FileTypeObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def FileType
  @FileType
end

#LimitObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def Limit
  @Limit
end

#OffsetObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def Offset
  @Offset
end

#OperatorObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def Operator
  @Operator
end

#SceneObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def Scene
  @Scene
end

#UrlTtlObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

  • JPG
  • PDF
  • ZIP
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • BusinessType:

    文件对应的业务类型,目前支持:

    • FLOW ** : 如需下载合同文件请选择此项
    • TEMPLATE ** : 如需下载模板文件请选择此项
    • DOCUMENT : 如需下载文档文件请选择此项
    • SEAL : 如需下载印章图片请选择此项
    • DIGITFILE: 如需下载加签文件请选择此项

  • BusinessIds:

    业务编号的数组,取值如下:

    • 流程编号
    • 模板编号
    • 文档编号
    • 印章编号
    • 加签文件编号
    • 如需下载合同文件请传入FlowId,最大支持20个资源

  • FileName:

    下载后的文件命名,只有FileType为zip的时候生效

  • FileType:

    要下载的文件类型,取值如下:

  • Offset:

    指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。

  • Limit:

    指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。

  • UrlTtl:

    下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)

  • CcToken:

    暂不开放

  • Scene:

    暂不开放

  • Agent:

    代理企业和员工的信息。



10191
10192
10193
# File 'lib/v20201111/models.rb', line 10191

def UrlTtl
  @UrlTtl
end

Instance Method Details

#deserialize(params) ⇒ Object



10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
# File 'lib/v20201111/models.rb', line 10212

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  @BusinessType = params['BusinessType']
  @BusinessIds = params['BusinessIds']
  @FileName = params['FileName']
  @FileType = params['FileType']
  @Offset = params['Offset']
  @Limit = params['Limit']
  @UrlTtl = params['UrlTtl']
  @CcToken = params['CcToken']
  @Scene = params['Scene']
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
end