SkySync API (v1.0.0)
Download OpenAPI specification: Download
Contact:
skysync
info@skysync.com
Overview
The SkySync API allows you to automate all aspects of SkySync, allowing you to sync, copy, or move files across systems. You can find out more about SkySync at https://www.skysync.com.
The Features section of the online documentation provides examples of how to use the API to accomplish specific tasks, such as cloning a job, creating a job that filters content based on metadata, and configuring a job stop policy.
Tools
There is a command-line utility that can be used to interact with a subset of the ReST API. The utility is published as an npm package with documentation provided online.
Authentication
List established connections
This method will allow you to page all established connections.
Parameters
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConnectionsResponse response
get
/connections200 ConnectionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Adds a new connection.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
post
/connections{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Delete all matched connections.
If query information is provided, then it will delete all connections that match a given query.
Parameters
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/connectionsList all available storage platforms.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
active
boolean
A flag to indicate whether to only return enabled or disabled platforms.
source
boolean
A hint of the transfer direction to further limit connection platforms to only source-enabled platforms.
destination
boolean
A hint of the transfer direction to further limit connection platforms to only destination-enabled platforms.
preferred
boolean
A flag to indicate whether to only return the current user's preferred platforms.
features
string
The connection platform features.
Responses
200 StoragePlatformsResponse response
get
/connections/platforms200 StoragePlatformsResponse response
{}
],
}
],
}
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
}
}
Get connection platform by name.
Parameters
platform
string
Required
The storage platform name.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 StoragePlatformResponse response
404 A storage platform with the specified name does not exist.
get
/connections/platforms/{platform}200 StoragePlatformResponse response
{}
],
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
}
}
Add new connection to storage platform.
Parameters
platform
string
Required
The storage platform name.
name
string
The connection name.
redirect
string
The URI to redirect to after connection added.
format
string
The response format.
client_id
string
The client_id parameter.
client_secret
string
The client_secret parameter.
client_domain
string
The client_domain parameter.
admin_mode
boolean
"false"
type
string
"oauth"
"oauth2"
"prompt"
A hint to determine how authentication should be established to platform.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AuthorizeResponse response
302 Redirects to storage platform for external authentication.
404 A connection platform with the specified name does not exist.
get
/connections/platforms/{platform}/new200 AuthorizeResponse response
{}
],
}
},
},
}
},
}
},
},
}
}
List accounts for a specific connection.
Parameters
connection
string
Required
The connection id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccountsResponse response
404 A connection with the specified ID does not exist.
get
/connections/{connection}/accounts200 AccountsResponse response
{}
],
}
],
}
],
}
},
}
},
}
},
}
}
Gets specific account by id for a specific connection.
Parameters
connection
string
Required
The connection id.
account
string
Required
The account id.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccountResponse response
404 A connection with the specified ID does not exist.
get
/connections/{connection}/accounts/{account}200 AccountResponse response
{}
],
}
},
],
}
},
}
},
}
},
}
}
Upload new file.
Parameters
connection
string
Required
The connection id.
path
string
The parent folder path.
name
string
The new file name.
url
string
The URL to the file contents to be uploaded.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The created-by to use to upload the new version.
X-Modified-At
string
The created-on timestamp.
X-Modified-By
string
The created-by to use to upload the new version.
Responses
200 ItemResponse response
400 The file contents were not provided.
404 A connection with the specified ID does not exist or the specified Path does not exist.
post
/connections/{connection}/content200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Upload new file.
Parameters
connection
string
Required
The connection id.
id
string
Required
The parent folder ID.
name
string
The new file name.
url
string
The URL to the file contents to be uploaded.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The created-by to use to upload the new version.
X-Modified-At
string
The created-on timestamp.
X-Modified-By
string
The created-by to use to upload the new version.
Responses
200 ItemResponse response
400 The file contents were not provided.
404 A connection with the specified ID does not exist or the folder ID does not exist.
405 The storage platform does not support loading by a folder ID.
put
/connections/{connection}/content/{id}200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Retrieve metadata for a specific file.
Parameters
connection
string
Required
The connection id.
path
string
The path to the file.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
get
/connections/{connection}/files200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
name
string
The new folder name.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new folder name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
patch
/connections/{connection}/files{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete file
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the file.
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
delete
/connections/{connection}/filesDownload the contents of a file.
Parameters
connection
string
Required
The connection id.
path
string
The file path.
version
string
The file version ID.
rendition
string
"original"
"rendition"
A flag to use an alternate rendition if available.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The connection with the specified ID is disabled.
get
/connections/{connection}/files/content200 IActionResultTask response
{ }
Upload new version of existing file.
Parameters
connection
string
Required
The connection id.
path
string
The file path.
url
string
The URL to the file contents to be uploaded.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The created-by to use to upload the new version.
X-Modified-At
string
The created-on timestamp.
X-Modified-By
string
The created-by to use to upload the new version.
Responses
200 IActionResultTask response
400 The file contents were not provided.
404 A connection with the specified ID does not exist or the specified Path does not exist.
put
/connections/{connection}/files/content200 IActionResultTask response
{ }
Retrieve list of file metadata
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 PropertySchemaValuesResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
get
/connections/{connection}/files/metadata200 PropertySchemaValuesResponse response
{}
],
}
},
}
}
},
}
}
Add file metadata
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The file metadata to be added.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
post
/connections/{connection}/files/metadata{}
}
}
200 IActionResultTask response
{ }
Update values of file metadata
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
File metadata value changes.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
put
/connections/{connection}/files/metadata{}
}
}
200 IActionResultTask response
{ }
Delete file metadata
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The file metadata to be deleted.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
delete
/connections/{connection}/files/metadata{}
}
}
Retrieve list of file permissions
Parameters
connection
string
Required
The connection id.
path
string
The file path.
inherit
boolean
"false"
Flag to include permissions inherited from parent folder.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccessRuleSetResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file permissions.
get
/connections/{connection}/files/permissions200 AccessRuleSetResponse response
{}
],
}
},
]
}
}
},
}
},
}
}
Update file permissions
Parameters
connection
string
Required
The connection id.
path
string
The file path.
inherit
boolean
Flag to allow inherited permissions.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
List of permission updates.
| access null |
string
"allow" "deny"
|
|
|
|
| id null |
string
|
|
|
|
| rights null |
string
"append" "delete" "full" "full_permissions" "none" "read" "read_permissions" "read_write" "write" "write_permissions"
|
|
|
|
| sid null |
SID
|
|
|
|
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file permissions.
put
/connections/{connection}/files/permissions[]
}
}
},
}
200 IActionResultTask response
{ }
Retrieve list of file versions
Parameters
connection
string
Required
The connection id.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemVersionsResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file versions.
get
/connections/{connection}/files/versions200 ItemVersionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete file version
Parameters
connection
string
Required
The connection id.
version
string
Required
The version ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the version.
Responses
200
404 A connection with the specified ID does not exist or the file ID does not exist or the version ID does not exist.
405 The storage platform does not support file versions.
delete
/connections/{connection}/files/versions/{version}Promote file version
Parameters
connection
string
Required
The connection id.
version
string
Required
The version ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Modified-At
string
The modified-on timestamp.
X-Modified-By
string
The modified-by to use to promote the version.
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the file ID does not exist or the version ID does not exist.
405 The storage platform does not support file versions.
post
/connections/{connection}/files/versions/{version}/promote200 IActionResultTask response
{ }
Retrieve metadata for a specific file.
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the file ID does not exist.
405 The storage platform does not support loading by a file ID.
get
/connections/{connection}/files/{id}200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
name
string
The new file name.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new file name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a file ID.
patch
/connections/{connection}/files/{id}{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete file
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the file.
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a file ID.
delete
/connections/{connection}/files/{id}Download the contents of a file.
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
version
string
The file version ID.
rendition
string
"original"
"rendition"
A flag to use an alternate rendition if available.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the file ID does not exist.
405 The storage platform does not support loading by a file ID.
get
/connections/{connection}/files/{id}/content200 IActionResultTask response
{ }
Upload new version of existing file.
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
url
string
The URL to the file contents to be uploaded.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The created-by to use to upload the new version.
X-Modified-At
string
The created-on timestamp.
X-Modified-By
string
The created-by to use to upload the new version.
Responses
200 IActionResultTask response
400 The file contents were not provided.
404 A connection with the specified ID does not exist or the file ID does not exist.
405 The storage platform does not support loading by a file ID.
put
/connections/{connection}/files/{id}/content200 IActionResultTask response
{ }
Retrieve list of file metadata
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccessRuleSetResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
get
/connections/{connection}/files/{id}/metadata200 AccessRuleSetResponse response
{}
],
}
},
]
}
}
},
}
},
}
}
Add file metadata
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The file metadata to be added.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
post
/connections/{connection}/files/{id}/metadata{}
}
}
200 IActionResultTask response
{ }
Update values of file metadata
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
File metadata value changes.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
put
/connections/{connection}/files/{id}/metadata{}
}
}
200 IActionResultTask response
{ }
Delete file metadata
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The file metadata to be deleted.
| {name} null |
PropertyValues
|
||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file metadata.
delete
/connections/{connection}/files/{id}/metadata{}
}
}
Retrieve list of file permissions
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
inherit
boolean
"false"
Flag to include permissions inherited from parent folder.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccessRuleSetResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file permissions.
get
/connections/{connection}/files/{id}/permissions200 AccessRuleSetResponse response
{}
],
}
},
]
}
}
},
}
},
}
}
Update file permissions
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
inherit
boolean
Flag to allow inherited permissions.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
List of permission updates.
| access null |
string
"allow" "deny"
|
|
|
|
| id null |
string
|
|
|
|
| rights null |
string
"append" "delete" "full" "full_permissions" "none" "read" "read_permissions" "read_write" "write" "write_permissions"
|
|
|
|
| sid null |
SID
|
|
|
|
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support file permissions.
put
/connections/{connection}/files/{id}/permissions[]
}
}
},
}
200 IActionResultTask response
{ }
Retrieve list of file versions
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemVersionsResponse response
404 A connection with the specified ID does not exist or the file ID does not exist.
405 The storage platform does not support loading by a file ID or storage platform does not support file versions.
get
/connections/{connection}/files/{id}/versions200 ItemVersionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete file version
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
version
string
Required
The version ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the version.
Responses
200
404 A connection with the specified ID does not exist or the file ID does not exist or the version ID does not exist.
405 The storage platform does not support loading by a file ID or storage platform does not support file versions.
delete
/connections/{connection}/files/{id}/versions/{version}Promote file version
Parameters
connection
string
Required
The connection id.
id
string
Required
The file ID.
version
string
Required
The version ID.
path
string
The file path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Modified-At
string
The modified-on timestamp.
X-Modified-By
string
The modified-by to use to promote the version.
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the file ID does not exist or the version ID does not exist.
405 The storage platform does not support loading by a file ID or storage platform does not support file versions.
post
/connections/{connection}/files/{id}/versions/{version}/promote200 IActionResultTask response
{ }
Retrieve metadata for a specific folder.
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
get
/connections/{connection}/folders200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
name
string
The new folder name.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new folder name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
patch
/connections/{connection}/folders{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete folder and all children
This operation is recursive meaning that it will delete all children underneath this folder. * If the storage platform supports loading via a folder ID, then it is recommended that you use the appropriate API for that as providing the path will cause recursive loading.
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the folder.
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
delete
/connections/{connection}/foldersRetrieve list of folder permissions
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
inherit
boolean
"false"
Flag to include permissions inherited from parent folder.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccessRuleSetResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support folder permissions.
get
/connections/{connection}/folders/permissions200 AccessRuleSetResponse response
{}
],
}
},
]
}
}
},
}
},
}
}
Update folder permissions
Parameters
connection
string
Required
The connection id.
path
string
The folder path.
inherit
boolean
Flag to allow inherited permissions.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
List of permission updates.
| access null |
string
"allow" "deny"
|
|
|
|
| id null |
string
|
|
|
|
| rights null |
string
"append" "delete" "full" "full_permissions" "none" "read" "read_permissions" "read_write" "write" "write_permissions"
|
|
|
|
| sid null |
SID
|
|
|
|
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support folder permissions.
put
/connections/{connection}/folders/permissions[]
}
}
},
}
200 IActionResultTask response
{ }
Retrieve metadata for a specific folder.
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
path
string
The folder path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the folder ID does not exist.
405 The storage platform does not support loading by a folder ID.
get
/connections/{connection}/folders/{id}200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Add new folder
Parameters
connection
string
Required
The connection id.
id
string
Required
path
string
The parent folder path.
name
string
The new folder name.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The user to use to create the new folder.
Request Body
The request body with the new folder.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
post
/connections/{connection}/folders/{id}{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
name
string
The new folder name.
path
string
The folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new folder name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a folder ID.
patch
/connections/{connection}/folders/{id}{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete folder and all children
This operation is recursive meaning that it will delete all children underneath this folder.
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
path
string
The folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the folder.
Responses
200
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a folder ID.
delete
/connections/{connection}/folders/{id}Retrieve list of folder permissions
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
inherit
boolean
"false"
Flag to include permissions inherited from parent folder.
path
string
The folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccessRuleSetResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support folder permissions.
get
/connections/{connection}/folders/{id}/permissions200 AccessRuleSetResponse response
{}
],
}
},
]
}
}
},
}
},
}
}
Update folder permissions
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
path
string
The folder path.
inherit
boolean
Flag to allow inherited permissions.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
List of permission updates.
| access null |
string
"allow" "deny"
|
|
|
|
| id null |
string
|
|
|
|
| rights null |
string
"append" "delete" "full" "full_permissions" "none" "read" "read_permissions" "read_write" "write" "write_permissions"
|
|
|
|
| sid null |
SID
|
|
|
|
Responses
200 IActionResultTask response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support folder permissions.
put
/connections/{connection}/folders/{id}/permissions[]
}
}
},
}
200 IActionResultTask response
{ }
List groups for a specific connection.
Parameters
connection
string
Required
The connection id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 GroupsResponse response
404 A connection with the specified ID does not exist.
get
/connections/{connection}/groups200 GroupsResponse response
{}
],
}
],
}
},
}
},
}
}
Gets specific group by id for a specific connection.
Parameters
connection
string
Required
The connection id.
group
string
Required
The group id.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 GroupResponse response
404 A connection with the specified ID does not exist.
get
/connections/{connection}/groups/{group}200 GroupResponse response
{}
],
}
},
},
}
},
}
}
List folders and files for a specific connection.
Parameters
connection
string
Required
The connection id.
path
string
If present, will list folders and files within the specific path.
type
string
"containers"
"files"
"folders"
"items"
If present, can filter items by type (i.e. folders and files)
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemsResponse response
404 A connection with the specified ID does not exist or if ?path present then the specified Path does not exist.
get
/connections/{connection}/items200 ItemsResponse response
{}
],
}
],
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete list of folders and files from a parent
Parameters
connection
string
Required
The connection id.
path
string
The parent folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the folder.
Request Body
The list of items to delete from the parent.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200
400 The list of items to delete was not provided.
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a folder ID.
delete
/connections/{connection}/items[]
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
List folders and files for a specific folder ID.
The storage platform must support loading by folder ID in order to call this method.
Parameters
connection
string
Required
The connection id.
id
string
Required
The folder ID.
type
string
"containers"
"files"
"folders"
"items"
If present, can filter items by type (i.e. folders and files)
path
string
The folder path.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemsResponse response
404 A connection with the specified ID does not exist or the folder or file ID does not exist.
405 The storage platform does not support loading by a folder ID.
get
/connections/{connection}/items/{id}200 ItemsResponse response
{}
],
}
],
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Delete list of folders and files from a parent
Parameters
connection
string
Required
The connection id.
id
string
Required
The parent folder ID.
path
string
The parent folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Deleted-At
string
The deleted-on timestamp.
X-Deleted-By
string
The user to use to delete the folder.
Request Body
The list of items to delete from the parent.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200
400 The list of items to delete was not provided.
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a folder ID.
delete
/connections/{connection}/items/{id}[]
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
Adds a connection to a connection pool.
Parameters
connection
string
Required
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
| id null |
string
|
|
|
|
| name null |
string
|
|
|
|
Responses
200 ConnectionResponse response
patch
/connections/{connection}/pool{}
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Get a connection by ID.
Returns the specified connection. A connection to the storage platform will be opened prior to being returned if one or more of the following conditions is met. * ?fields=auth is included in request query string.
* ?fields=features is included in request query string.
* ?fields=profile is included in request query string.
* ?test is included in request query string.
Parameters
id
string
Required
The connection id.
fields
Comma Separated
string
Attribute(s) to include in the response
test
boolean
"false"
If true then the connection will be opened prior to being returned.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
get
/connections/{id}200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Update a connection by ID.
In almost all regards, this method performs the same operation as a PATCH. There are few notible exceptions: * If ?reauthenticate is passed then the connection will attempt to refresh the authentication details.
* If ?enable is passed then the connection will be re-enabled.
* If ?disable is passed then the connection will be disabled.
Parameters
id
string
Required
The connection id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
put
/connections/{id}{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Patch a connection by ID.
Patches a connection based on the properties included in the response: * If the name property is included, then the connection will be renamed.
* If the auth property is included, then the authentication details for the connection will be validated and updated.
Parameters
id
string
Required
The connection id.
reauthenticate
boolean
"false"
enable
boolean
"false"
disable
boolean
"false"
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate when reauthenticating the connection.
X-Connect-Uri
string
The url to use when reauthenticating the connection.
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
patch
/connections/{id}{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Edit a connection by ID.
Returns details on how to edit connection authentication. The response type depends in part on
Parameters
id
string
Required
The connection id.
type
string
"oauth"
"oauth2"
"prompt"
A hint to determine how authentication should be established to platform.
redirect
string
The URI to redirect to after connection added.
format
string
The response format.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AuthorizeResponse response
302 Redirects to storage platform for external authentication
get
/connections/{id}/edit200 AuthorizeResponse response
{}
],
}
},
},
}
},
}
},
},
}
}
List available account maps
This method will allow you to page all account maps.
Parameters
platform
Comma Separated
string
The connection platform name.
source
Comma Separated
string
The source connection platform name.
destination
Comma Separated
string
The destination connection platform name.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
features
Comma Separated
string
The connection platform features.
connection
string
The source/destination connection id.
account
string
The source/destination connection account.
item
string
The source/destination platform item id.
path
string
The source/destination platform item path.
sourceconnection
string
The source connection id.
sourceaccount
string
The source connection account.
sourceitem
string
The source platform item id.
sourcepath
string
The source platform item path.
sourcetype
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
destinationconnection
string
The destination connection id.
destinationaccount
string
The destination connection account.
destinationitem
string
The destination platform item id.
destinationpath
string
The destination platform item path.
destinationtype
string
"directory"
"metadata"
The destination type.
type
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AccountMapsResponse response
get
/account_maps200 AccountMapsResponse response
{}
],
}
],
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Add account map.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
post
/account_maps{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Gets a template for creating new account maps.
Responses
200 AccountMapTemplateResponse response
get
/account_maps/new200 AccountMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Gets a template for creating new account maps.
Request Body
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapTemplateResponse response
post
/account_maps/new{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Get a account map by ID.
Parameters
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
get
/account_maps/{id}200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Update account map.
Parameters
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
put
/account_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Patch account map.
Parameters
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
patch
/account_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
List exceptions in account map
This method will allow you to page all exceptions within an account map.
Parameters
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExceptionsResponse response
get
/account_maps/{id}/exceptions200 AccountExceptionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
}
}
Modify exceptions in an account map
Parameters
id
string
Required
The account map id.
Request Body
| destination null |
Account
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Account
|
|
|
|
Responses
200 IActionResultTask response
post
/account_maps/{id}/exceptions[]
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
List destination exclusions in account map
This method will allow you to page all destination exclusions within an account map.
Parameters
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExclusionsResponse response
get
/account_maps/{id}/exclusions/destination200 AccountExclusionsResponse response
{}
],
}
],
}
}
],
}
},
}
},
}
},
}
}
Modify destination exclusions in an account map
Parameters
id
string
Required
The account map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
Responses
200 IActionResultTask response
post
/account_maps/{id}/exclusions/destination[]
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
List source exclusions in account map
This method will allow you to page all source exclusions within an account map.
Parameters
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExclusionsResponse response
get
/account_maps/{id}/exclusions/source200 AccountExclusionsResponse response
{}
],
}
],
}
}
],
}
},
}
},
}
},
}
}
Modify source exclusions in an account map
Parameters
id
string
Required
The account map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
Responses
200 IActionResultTask response
post
/account_maps/{id}/exclusions/source[]
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
Gets available predefined filter groups.
Responses
200 PredefinedFilterGroupsResponse response
get
/filters/groups200 PredefinedFilterGroupsResponse response
{}
],
}
],
}
]
}
},
}
}
Gets a template for creating new content filters.
Parameters
source
string
The source connection or platform ID.
destination
string
The destination connection or platform ID.
Responses
200 TransferFilterTemplateResponse response
get
/filters/new200 TransferFilterTemplateResponse response
{}
],
}
},
},
],
}
]
}
}
],
}
]
}
},
}
}
List available group maps
This method will allow you to page all group maps.
Parameters
platform
Comma Separated
string
The connection platform name.
source
Comma Separated
string
The source connection platform name.
destination
Comma Separated
string
The destination connection platform name.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
features
Comma Separated
string
The connection platform features.
connection
string
The source/destination connection id.
account
string
The source/destination connection account.
item
string
The source/destination platform item id.
path
string
The source/destination platform item path.
sourceconnection
string
The source connection id.
sourceaccount
string
The source connection account.
sourceitem
string
The source platform item id.
sourcepath
string
The source platform item path.
sourcetype
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
destinationconnection
string
The destination connection id.
destinationaccount
string
The destination connection account.
destinationitem
string
The destination platform item id.
destinationpath
string
The destination platform item path.
destinationtype
string
"directory"
"metadata"
The destination type.
type
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 GroupMapsResponse response
get
/group_maps200 GroupMapsResponse response
{}
],
}
],
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Add group map.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
post
/group_maps{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Gets a template for creating new group maps.
Responses
200 GroupMapTemplateResponse response
get
/group_maps/new200 GroupMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Gets a template for creating new group maps.
Request Body
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapTemplateResponse response
post
/group_maps/new{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Get a group map by ID.
Parameters
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
get
/group_maps/{id}200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Update group map.
Parameters
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
put
/group_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Patch group map.
Parameters
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
patch
/group_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
List exceptions in group map
This method will allow you to page all exceptions within an group map.
Parameters
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExceptionsResponse response
get
/group_maps/{id}/exceptions200 GroupExceptionsResponse response
{}
],
}
],
}
},
},
}
}
},
}
},
}
}
Modify exceptions in an group map
Parameters
id
string
Required
The group map id.
Request Body
| destination null |
Group
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Group
|
|
|
|
Responses
200 IActionResultTask response
post
/group_maps/{id}/exceptions[]
}
},
},
}
}
},
}
200 IActionResultTask response
{ }
List destination exclusions in group map
This method will allow you to page all destination exclusions within an group map.
Parameters
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExclusionsResponse response
get
/group_maps/{id}/exclusions/destination200 GroupExclusionsResponse response
{}
],
}
],
}
}
},
}
},
}
}
Modify destination exclusions in an group map
Parameters
id
string
Required
The group map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Group
|
|
|
|
Responses
200 IActionResultTask response
post
/group_maps/{id}/exclusions/destination[]
}
}
},
}
200 IActionResultTask response
{ }
List source exclusions in group map
This method will allow you to page all source exclusions within an group map.
Parameters
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExclusionsResponse response
get
/group_maps/{id}/exclusions/source200 GroupExclusionsResponse response
{}
],
}
],
}
}
},
}
},
}
}
Modify source exclusions in an group map
Parameters
id
string
Required
The group map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Group
|
|
|
|
Responses
200 IActionResultTask response
post
/group_maps/{id}/exclusions/source[]
}
}
},
}
200 IActionResultTask response
{ }
List available jobs
This method will allow you to page all jobs.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobsResponse response
get
/jobs200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Add job.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
post
/jobs{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Patch jobs.
Parameters
start
boolean
"false"
A flag to indicate that the job should be started.
cancel
boolean
"false"
A flag to indicate that the job should be cancelled.
pause
boolean
"false"
A flag to indicate that the job should be paused.
resume
boolean
"false"
A flag to indicate that the job should be resumed.
reset
string
A flag to indicate that the job state should be reset.
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobsResponse response
404 A job with the specified ID does not exist.
patch
/jobs200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Delete all matched jobs.
If query information is provided, then it will delete all jobs that match a given query.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/jobsGets a list of job template types.
Responses
200 ScheduledJobDescriptionsResponse response
get
/jobs/new200 ScheduledJobDescriptionsResponse response
{}
],
}
],
}
},
}
}
Gets a template for creating a new job.
Parameters
type
string
Required
Responses
200 NewScheduledJobTemplateResponse response
get
/jobs/new/{type}200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a new job.
Parameters
type
string
Required
Request Body
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 NewScheduledJobTemplateResponse response
post
/jobs/new/{type}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Get a job by ID.
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
get
/jobs/{id}200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Update a job.
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
put
/jobs/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Patch a job.
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
start
boolean
"false"
A flag to indicate that the job should be started.
cancel
boolean
"false"
A flag to indicate that the job should be cancelled.
pause
boolean
"false"
A flag to indicate that the job should be paused.
resume
boolean
"false"
A flag to indicate that the job should be resumed.
reset
string
A flag to indicate that the job state should be reset.
Request Body
The updated job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
patch
/jobs/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Create a new job by cloning an existing job.
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
JSON override options.
Responses
200 ScheduledJobResponse response
post
/jobs/{id}/clone"string"
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a editing an existing job.
Parameters
id
string
Required
Responses
200 NewScheduledJobTemplateResponse response
get
/jobs/{id}/edit200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
List or search for available categories.
Parameters
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 TransferAuditCategoriesResponse response
get
/transfers/categories200 TransferAuditCategoriesResponse response
{}
],
}
],
}
},
]
}
},
}
}
Add a new category.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 No category provided with request.
409 A category with the same name already exists.
post
/transfers/categories{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Delete categories that match specified criteria.
Parameters
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200
delete
/transfers/categoriesGet category by id.
Parameters
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditCategoryResponse response
404 A category with the specified ID does not exist.
get
/transfers/categories/{id}200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Update category.
Parameters
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 A category was not provided with the request.
404 A category with the specified ID does not exist.
put
/transfers/categories/{id}{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Patch category.
Parameters
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The patched category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 A category was not provided with the request.
404 A category with the specified ID does not exist.
patch
/transfers/categories/{id}{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
List exceptions in personal drive convention
This method will allow you to page all exceptions within a personal drive convention.
Parameters
id
string
Required
The job id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 PersonalDriveExceptionsResponse response
get
/transfers/{id}/personal_drives/exceptions200 PersonalDriveExceptionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
}
}
Modify exceptions in a personal drive convention
Parameters
id
string
Required
The job id.
Request Body
| destination null |
Account
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Account
|
|
|
|
Responses
200 IActionResultTask response
post
/transfers/{id}/personal_drives/exceptions[]
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
List include/exclude matches in personal drive convention
This method will allow you to page all include/exclude within a personal drive convention.
Parameters
id
string
Required
The job id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 PersonalDriveMatchsResponse response
get
/transfers/{id}/personal_drives/matches200 PersonalDriveMatchsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
}
}
Modify include/exclude matches in personal drive convention
Parameters
id
string
Required
The job id.
Request Body
| category null |
string
<= 380 characters
|
|
|
|
| destination_convention null |
string
<= 500 characters
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
| source_uri null |
string
<= 500 characters
|
|
|
|
Responses
200 IActionResultTask response
post
/transfers/{id}/personal_drives/matches[]
}
},
],
}
},
}
},
}
200 IActionResultTask response
{ }
List available application job executions.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
get
/applications/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
List available job executions for the specified application.
This method will allow you to page all job executions posted by an application
Parameters
id
string
Required
The application id.
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
get
/applications/{id}/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
Gets audit logs for all convention jobs.
Parameters
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
get
/conventions/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job.
Parameters
id
string
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
get
/conventions/{id}/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job execution.
Parameters
id
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
get
/conventions/{id}/executions/{execution}/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job execution in comma-delimited text format
Parameters
id
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResultTask response
get
/conventions/{id}/executions/{execution}/auditing.csv200 CsvOutputResultTask response
{ }
List available job history
This method will allow you to page all job history.
Parameters
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionsResponse response
get
/jobs/history200 JobExecutionsResponse response
{}
],
}
],
}
},
},
},
},
}
}
List available history for specified job
This method will allow you to page job history for specified job.
Parameters
id
string
Required
The job id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionsResponse response
404 A job with the specified ID does not exist.
get
/jobs/{id}/history200 JobExecutionsResponse response
{}
],
}
],
}
},
},
},
},
}
}
Get current execution for specified job
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
get
/jobs/{id}/history/current200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
Get last execution for specified job
Parameters
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
get
/jobs/{id}/history/last200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
Get specified execution for specified job
Parameters
id
string
Required
The job id.
execution
integer <int64>
Required
The execution id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
404 Either the job or the execution does not exist.
get
/jobs/{id}/history/{execution}200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
List available application job executions.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
get
/profiles/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
List available job executions for the specified application.
This method will allow you to page all job executions posted by all applications associated with the specified profile.
Parameters
id
string
Required
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
get
/profiles/{id}/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
transfersauditlog_portalarchitects.transfers.services.v1.transfersauditlogcontroller.list (portalarchitects.transfers.services)
Parameters
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
get
/transfers/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
List or search for transfer items.
Parameters
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
get
/transfers/items200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
List or search for flagged transfer items.
Parameters
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
get
/transfers/items/flagged200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Export flagged transfer items to CSV.
Parameters
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResult response
get
/transfers/items/flagged.csv200 CsvOutputResult response
{ }
Gets the transfer item for a specified ID.
Parameters
itemid
integer <int64>
Required
The transfer item ID.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemResponse response
404 A transfer item with the specified ID does not exist.
get
/transfers/items/{itemid}200 TransferItemResponse response
{}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Modify the status of a transfer item give a specified ID.
Parameters
itemid
integer <int64>
Required
The transfer item ID.
status
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The transfer item status.
ignore
boolean
Ignore the specified transfer item.
retry
boolean
Retry the specified transfer item.
recurse
boolean
Apply status change to transfer item and all children.
Responses
200 TransferItemResponse response
patch
/transfers/items/{itemid}200 TransferItemResponse response
{}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Gets audit logs for a specific job.
Parameters
id
string
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
get
/transfers/{id}/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Gets transfer items for a specified job.
Parameters
id
string
Required
The job ID.
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
get
/transfers/{id}/items200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Lists all available transfer statistics.
Parameters
id
string
Required
The job ID.
range
string
The date range of timeline entries.
limit
integer <int32>
The maximum number of timeline entries.
Responses
200 TransferStatisticsListResponse response
404 The specified job ID does not exist.
get
/transfers/{id}/stats200 TransferStatisticsListResponse response
{}
],
}
},
},
}
},
}
},
}
},
}
},
}
},
}
]
}
},
}
},
}
},
}
}
Provides access to transfer statistics by category.
Parameters
id
string
Required
The job ID.
Responses
200 TransferCategoryStatisticsResponse response
404 The specified job ID does not exist.
get
/transfers/{id}/stats/by_category200 TransferCategoryStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics by status.
Parameters
id
string
Required
The job ID.
Responses
200 TransferStatusStatisticsResponse response
404 The specified job ID does not exist.
get
/transfers/{id}/stats/by_status200 TransferStatusStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics by processing qualification.
Parameters
id
string
Required
The job ID.
Responses
200 TransferProcessingStatisticsResponse response
404 The specified job ID does not exist.
get
/transfers/{id}/stats/processing200 TransferProcessingStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics timeline.
Parameters
id
string
Required
The job ID.
range
string
The date range of timeline entries.
limit
integer <int32>
The maximum number of timeline entries.
Responses
200 TransferStatusStatisticsTimelinesResponse response
404 The specified job ID does not exist.
get
/transfers/{id}/stats/timeline200 TransferStatusStatisticsTimelinesResponse response
{}
],
}
],
}
},
}
},
}
},
}
}
Gets audit logs for a specific job execution.
Parameters
job
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
get
/transfers/{job}/executions/{execution}/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
transfersauditlog_portalarchitects.transfers.services.v1.transfersauditlogcontroller.byexecutionascsv (portalarchitects.transfers.services)
Parameters
job
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResultTask response
get
/transfers/{job}/executions/{execution}/auditing.csv200 CsvOutputResultTask response
{ }
List available job profiles
This method will allow you to page all job profiles.
Parameters
template_id
string
Template id filter.
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ProfilesResponse response
get
/profiles200 ProfilesResponse response
{}
],
}
],
}
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
},
}
}
Add job profile.
Parameters
generateclient
boolean
"false"
A flag indicating if a client application should be auto-generated for the new job profile.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new job profile.
| applications null |
SecurityApplication
|
|
|
|
| configuration null |
JobProfileConfiguration
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| dismissed_on null |
string <date-time>
|
|
|
|
| generateclient null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| instructions null |
string
<= 4000 characters
|
|
|
|
| job_templates null |
ScheduledJob
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ProfileResponse response
post
/profiles{}
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
200 ProfileResponse response
{}
],
}
},
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
},
}
}
Delete all matched job profiles.
If query information is provided, then it will delete all job profiles that match a given query.
Parameters
template_id
string
Template id filter.
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/profilesGet a job profile by ID.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ProfileResponse response
404 A job profile with the specified ID does not exist.
get
/profiles/{id}200 ProfileResponse response
{}
],
}
},
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
},
}
}
Update a job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job profile.
| applications null |
SecurityApplication
|
|
|
|
| configuration null |
JobProfileConfiguration
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| dismissed_on null |
string <date-time>
|
|
|
|
| generateclient null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| instructions null |
string
<= 4000 characters
|
|
|
|
| job_templates null |
ScheduledJob
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ProfileResponse response
404 A job profile with the specified ID does not exist.
put
/profiles/{id}{}
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
200 ProfileResponse response
{}
],
}
},
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
},
}
}
Patch a job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job profile.
| applications null |
SecurityApplication
|
|
|
|
| configuration null |
JobProfileConfiguration
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| dismissed_on null |
string <date-time>
|
|
|
|
| generateclient null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| instructions null |
string
<= 4000 characters
|
|
|
|
| job_templates null |
ScheduledJob
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ProfileResponse response
404 A job profile with the specified ID does not exist.
patch
/profiles/{id}{}
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
200 ProfileResponse response
{}
],
}
},
],
}
},
}
},
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
},
}
}
List applications associated with job profile
Parameters
id
string
Required
The job profile id.
active
boolean
A flag to determine if result should only include active security applications.
kinds
Comma Separated
string
The application types.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityApplicationsResponse response
get
/profiles/{id}/applications200 SecurityApplicationsResponse response
{}
],
}
],
}
},
}
},
}
}
Associate application list with the job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Application list to add
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationsResponse response
post
/profiles/{id}/applications[]
}
},
}
200 SecurityApplicationsResponse response
{}
],
}
],
}
},
}
},
}
}
Replaces application list associated with job profile
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Updated application list.
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationsResponse response
put
/profiles/{id}/applications[]
}
},
}
200 SecurityApplicationsResponse response
{}
],
}
],
}
},
}
},
}
}
Associate application list with the job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Application list to add
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationsResponse response
patch
/profiles/{id}/applications[]
}
},
}
200 SecurityApplicationsResponse response
{}
],
}
],
}
},
}
},
}
}
Download agent configuration for given profile
Parameters
id
string
Required
The job profile id.
platform
string
"\"windows\""
"linux"
"osx"
"unknown"
"windows"
The client platform (e.g. windows, osx, or linux).
application
string
Responses
200 IActionResultTask response
404 A job profile with the specified ID does not exist.
get
/profiles/{id}/download200 IActionResultTask response
{ }
List job templates associated with job profile
Parameters
id
string
Required
The job profile id.
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
include_disabled_templates
boolean
Responses
200 ScheduledJobsResponse response
get
/profiles/{id}/templates200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Associate job template list with the job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Template list to add
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobsResponse response
post
/profiles/{id}/templates[]
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Replaces job template list associated with job profile
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Updated job template list.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobsResponse response
put
/profiles/{id}/templates[]
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Associate job template list with the job profile.
Parameters
id
string
Required
The job profile id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
Template list to add
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobsResponse response
patch
/profiles/{id}/templates[]
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
List available job templates
This method will allow you to page all job templates.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobsResponse response
get
/templates200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Add job template.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new job template.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
post
/templates{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Delete all matched job templates.
If query information is provided, then it will delete all job templates that match a given query.
Parameters
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/templatesGets a list of job template types.
Responses
200 ScheduledJobDescriptionsResponse response
get
/templates/new200 ScheduledJobDescriptionsResponse response
{}
],
}
],
}
},
}
}
Gets a template for creating a new job.
Parameters
type
string
Required
Responses
200 NewScheduledJobTemplateResponse response
get
/templates/new/{type}200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a new job.
Parameters
type
string
Required
Request Body
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 NewScheduledJobTemplateResponse response
post
/templates/new/{type}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Get a job template by ID.
Parameters
id
string
Required
The job template id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobResponse response
404 A job template with the specified ID does not exist.
get
/templates/{id}200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Update job template.
Parameters
id
string
Required
The job template id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job template.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job template with the specified ID does not exist.
put
/templates/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Patch job template.
Parameters
id
string
Required
The job template id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
patch
/templates/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Create a new template by cloning an existing template.
Parameters
id
string
Required
The template id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
JSON override options.
Responses
200 ScheduledJobResponse response
post
/templates/{id}/clone"string"
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a new job.
Parameters
id
string
Required
Responses
200 NewScheduledJobTemplateResponse response
get
/templates/{id}/edit200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
List available job profiles associated with job template
This method will allow you to page all job profiles associated with a particular job template.
Parameters
id
string
Required
The job template id.
Responses
200 IActionResult response
get
/templates/{id}/profiles200 IActionResult response
{ }
List applications
This method will allow you to page all created applications.
Parameters
active
boolean
A flag to determine if result should only include active security applications.
kinds
Comma Separated
string
The application types.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityApplicationsResponse response
get
/applications200 SecurityApplicationsResponse response
{}
],
}
],
}
},
}
},
}
}
Adds a new application.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The application.
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationResponse response
post
/applications{}
},
}
200 SecurityApplicationResponse response
{}
],
}
},
},
}
},
}
}
Delete all matched applications.
If query information is provided, then it will delete all job profiles that match a given query.
Parameters
active
boolean
A flag to determine if result should only include active security applications.
kinds
Comma Separated
string
The application types.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/applicationsGet application by ID.
Parameters
id
string
Required
The application id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityApplicationResponse response
404 An application with the specified ID does not exist.
get
/applications/{id}200 SecurityApplicationResponse response
{}
],
}
},
},
}
},
}
}
Update an application by ID.
Parameters
id
string
Required
The application id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The application.
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationResponse response
404 An application with the specified ID does not exist.
put
/applications/{id}{}
},
}
200 SecurityApplicationResponse response
{}
],
}
},
},
}
},
}
}
Patch an application by ID.
Parameters
id
string
Required
The application id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The application.
| client_id null |
string
<= 40 characters
Required
|
|
|
|
| client_secret null |
string
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 1000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| kind null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityApplicationResponse response
404 An application with the specified ID does not exist.
patch
/applications/{id}{}
},
}
200 SecurityApplicationResponse response
{}
],
}
},
},
}
},
}
}
List ownership groups
This method will allow you to page all created ownership groups.
Parameters
user
string
Filter groups by user membership
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 OwnershipGroupsResponse response
get
/groups200 OwnershipGroupsResponse response
{}
],
}
],
}
},
}
},
}
}
Adds a new group.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The group.
| id null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| parent null |
OwnershipGroup (object)
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 OwnershipGroupResponse response
post
/groups{}
},
}
200 OwnershipGroupResponse response
{}
],
}
},
},
}
},
}
}
List ownership groups for current group
This method will allow you to page all ownership groups available to the current group.
Parameters
user
string
Filter groups by user membership
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 OwnershipGroupsResponse response
get
/groups/mine200 OwnershipGroupsResponse response
{}
],
}
],
}
},
}
},
}
}
Get an ownership group by ID.
Parameters
id
string
Required
The group id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 OwnershipGroupResponse response
404 An ownership group with the specified ID does not exist.
get
/groups/{id}200 OwnershipGroupResponse response
{}
],
}
},
},
}
},
}
}
Update a group by ID.
Parameters
id
string
Required
The group id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The group.
| id null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| parent null |
OwnershipGroup (object)
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 OwnershipGroupResponse response
404 A group with the specified ID does not exist.
put
/groups/{id}{}
},
}
200 OwnershipGroupResponse response
{}
],
}
},
},
}
},
}
}
Patch a group by ID.
Parameters
id
string
Required
The group id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The group.
| id null |
string
<= 40 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| parent null |
OwnershipGroup (object)
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 OwnershipGroupResponse response
404 A group with the specified ID does not exist.
patch
/groups/{id}{}
},
}
200 OwnershipGroupResponse response
{}
],
}
},
},
}
},
}
}
List all system permissions
Parameters
q
string
A query string for searching items.
Responses
200 PermissionCategoriesResponse response
get
/permissions200 PermissionCategoriesResponse response
{}
],
}
],
}
]
}
},
}
}
Get all system permissions for a category.
Parameters
category
string
Required
The permission category ID.
q
string
A query string for searching items.
Responses
200 PermissionCategoryResponse response
get
/permissions/{category}200 PermissionCategoryResponse response
{}
],
}
},
]
}
},
}
}
List permission roles
This method will allow you to page all created roles.
Parameters
permissions
Comma Separated
string
A list of permissions that must be granted
user
string
Filter roles by user membership
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityRolesResponse response
get
/roles200 SecurityRolesResponse response
{}
],
}
],
}
},
}
],
}
},
}
}
Adds a new role.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The role.
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityRoleResponse response
post
/roles{}
},
}
],
}
200 SecurityRoleResponse response
{}
],
}
},
},
}
],
}
},
}
}
List roles for current role
This method will allow you to page all roles assigned to the current role.
Parameters
permissions
Comma Separated
string
A list of permissions that must be granted
user
string
Filter roles by user membership
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityRolesResponse response
get
/roles/mine200 SecurityRolesResponse response
{}
],
}
],
}
},
}
],
}
},
}
}
Get a role by ID.
Parameters
id
string
Required
The role id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityRoleResponse response
404 A role with the specified ID does not exist.
get
/roles/{id}200 SecurityRoleResponse response
{}
],
}
},
},
}
],
}
},
}
}
Update a role by ID.
Parameters
id
string
Required
The role id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The role.
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityRoleResponse response
404 A role with the specified ID does not exist.
put
/roles/{id}{}
},
}
],
}
200 SecurityRoleResponse response
{}
],
}
},
},
}
],
}
},
}
}
Patch a role by ID.
Parameters
id
string
Required
The role id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The role.
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityRoleResponse response
404 A role with the specified ID does not exist.
patch
/roles/{id}{}
},
}
],
}
200 SecurityRoleResponse response
{}
],
}
},
},
}
],
}
},
}
}
Add permissions to role.
Parameters
id
string
Required
The role id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The permissions to add to the role.
| id null |
string
|
|
|
|
| name null |
string
|
|
|
|
Responses
200 SecurityRoleResponse response
404 A role with the specified ID does not exist.
patch
/roles/{id}/permissions[]
}
200 SecurityRoleResponse response
{}
],
}
},
},
}
],
}
},
}
}
List users
This method will allow you to page all created users.
Parameters
permissions
Comma Separated
string
A list of permissions that must be granted
group
string
Filter users by owner group membership
role
string
Filter users by role membership
active
boolean
A flag to determine if result should only include active users.
locked
boolean
A flag to determine if result should only include locked out users.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUsersResponse response
get
/users200 SecurityUsersResponse response
{}
],
}
],
}
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Adds a new user.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The user.
| disabled null |
boolean
|
|
|
|
| email null |
string
<= 255 characters
|
|
|
|
| group null |
OwnershipGroup
|
|
|
|
| groups null |
OwnershipGroup
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| locked null |
boolean
|
|
|
|
| login null |
string
<= 255 characters
Required
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| new_password null |
string
|
|
|
|
| old_password null |
string
|
|
|
|
| password null |
string
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| phone null |
string
<= 15 characters
|
|
|
|
| roles null |
SecurityRole
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityUserResponse response
post
/users{}
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Get the current user.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
get
/users/me200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Change the password for the current user.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
| disabled null |
boolean
|
|
|
|
| email null |
string
<= 255 characters
|
|
|
|
| group null |
OwnershipGroup
|
|
|
|
| groups null |
OwnershipGroup
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| locked null |
boolean
|
|
|
|
| login null |
string
<= 255 characters
Required
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| new_password null |
string
|
|
|
|
| old_password null |
string
|
|
|
|
| password null |
string
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| phone null |
string
<= 15 characters
|
|
|
|
| roles null |
SecurityRole
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
patch
/users/me{}
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Get the effective permissions for the current user.
Responses
200 GrantedPermissionsResponse response
404 A user with the specified ID does not exist.
get
/users/me/permissions200 GrantedPermissionsResponse response
{}
],
}
],
}
},
}
}
List current user preferences
This method will allow you to get the preferences for the current user.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserPreferencesResponse response
get
/users/me/preferences200 SecurityUserPreferencesResponse response
{}
],
}
],
}
},
}
},
}
}
List current user preferences
This method will allow you to get a specific preference for the current user.
Parameters
key
string
Required
The preference key or name.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserPreferenceResponse response
get
/users/me/preferences/{key}200 SecurityUserPreferenceResponse response
{}
],
}
},
},
}
},
}
}
Set user preference
This method will allow you to set a preference for the current user.
Parameters
key
string
Required
The name of the preference
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
| id null |
string
<= 255 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| type null |
string
|
|
|
|
| value null |
JSON (string)
|
|
|
|
Responses
200 SecurityUserPreferenceResponse response
patch
/users/me/preferences/{key}{}
},
}
200 SecurityUserPreferenceResponse response
{}
],
}
},
},
}
},
}
}
Get user by ID.
Parameters
id
string
Required
The user id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
get
/users/{id}200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Update a user by ID.
Parameters
id
string
Required
The user id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The user.
| disabled null |
boolean
|
|
|
|
| email null |
string
<= 255 characters
|
|
|
|
| group null |
OwnershipGroup
|
|
|
|
| groups null |
OwnershipGroup
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| locked null |
boolean
|
|
|
|
| login null |
string
<= 255 characters
Required
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| new_password null |
string
|
|
|
|
| old_password null |
string
|
|
|
|
| password null |
string
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| phone null |
string
<= 15 characters
|
|
|
|
| roles null |
SecurityRole
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
put
/users/{id}{}
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Patch a user by ID.
Parameters
id
string
Required
The user id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The user.
| disabled null |
boolean
|
|
|
|
| email null |
string
<= 255 characters
|
|
|
|
| group null |
OwnershipGroup
|
|
|
|
| groups null |
OwnershipGroup
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| locked null |
boolean
|
|
|
|
| login null |
string
<= 255 characters
Required
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| new_password null |
string
|
|
|
|
| old_password null |
string
|
|
|
|
| password null |
string
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| phone null |
string
<= 15 characters
|
|
|
|
| roles null |
SecurityRole
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
patch
/users/{id}{}
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Get effective permissions for user by ID.
Parameters
id
string
Required
The user id.
Responses
200 GrantedPermissionsResponse response
404 A user with the specified ID does not exist.
get
/users/{id}/permissions200 GrantedPermissionsResponse response
{}
],
}
],
}
},
}
}
List user preferences
This method will allow you to get the preferences for the specified user.
Parameters
id
string
Required
The user id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserPreferencesResponse response
404 A user with the specified ID does not exist.
get
/users/{id}/preferences200 SecurityUserPreferencesResponse response
{}
],
}
],
}
},
}
},
}
}
List user preferences
This method will allow you to get a specific preference for the specified user.
Parameters
id
string
Required
The user id.
key
string
Required
The preference key or name.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 SecurityUserPreferenceResponse response
404 A user with the specified ID does not exist.
get
/users/{id}/preferences/{key}200 SecurityUserPreferenceResponse response
{}
],
}
},
},
}
},
}
}
Set user preference
This method will allow you to set a preference for the specified user.
Parameters
id
string
Required
The user id.
key
string
Required
The name of the preference
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
| id null |
string
<= 255 characters
Required
|
|
|
|
| links null |
Links
|
|
|
|
| type null |
string
|
|
|
|
| value null |
JSON (string)
|
|
|
|
Responses
200 SecurityUserPreferenceResponse response
404 A user with the specified ID does not exist.
patch
/users/{id}/preferences/{key}{}
},
}
200 SecurityUserPreferenceResponse response
{}
],
}
},
},
}
},
}
}
Add roles to user by ID.
Parameters
id
string
Required
The user id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The roles to add to the user.
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| permissions null |
GrantedPermission
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 SecurityUserResponse response
404 A user with the specified ID does not exist.
patch
/users/{id}/roles[]
}
},
}
],
}
200 SecurityUserResponse response
{}
],
}
},
},
},
}
],
}
},
}
},
}
],
}
],
}
},
}
],
}
},
}
}
Get diagnostic log messages.
Parameters
error
boolean
"false"
The type of log messages to return (i.e. warn, error).
level
string
The log level.
latest
string
The latest log message timestamp filter.
Responses
200 LogEntriesResponse response
503 Diagnostic log messages are not available.
get
/diagnostics/logs200 LogEntriesResponse response
{}
],
}
],
}
},
}
}
get
/diagnostics/logs/configuration200 LogConfigurationResponse response
{}
],
}
},
},
}
}
Update current log configuration.
Request Body
The new log configuration.
| level null |
string
|
|
|
|
| retention_days null |
integer <int32>
|
|
|
|
Responses
200 LogConfigurationResponse response
post
/diagnostics/logs/configuration{}
200 LogConfigurationResponse response
{}
],
}
},
},
}
}
List available metrics.
Parameters
type
string
The metric type.
name
string
The metric name.
q
string
A query string for searching metrics.
Responses
200 MetricsResponse response
get
/diagnostics/metrics200 MetricsResponse response
{}
],
}
},
}
},
}
}
List available remote sites
This method will allow you to page all remote sites.
Parameters
connected
boolean
A flag to only query remote sites based on connection status.
active
boolean
A flag to determine if result should only include active sites.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 RemoteSitesResponse response
get
/sites200 RemoteSitesResponse response
{}
],
}
],
}
},
}
},
}
}
Add remote site.
Parameters
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new remote site.
| connected null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
|
|
|
|
| disabled null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| ip_address null |
string
<= 45 characters
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| status_updated_on null |
string <date-time>
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 RemoteSiteResponse response
post
/sites{}
},
}
200 RemoteSiteResponse response
{}
],
}
},
},
}
},
}
}
Delete all matched remote sites.
If query information is provided, then it will delete all remote sites that match a given query.
Parameters
connected
boolean
A flag to only query remote sites based on connection status.
active
boolean
A flag to determine if result should only include active sites.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
delete
/sitesEstablish a new remote site.
Parameters
name
string
An optional name for the new remote site.
platform
string
"linux"
"osx"
"unknown"
"windows"
The client platform (e.g. windows, osx, or linux).
Responses
200 IActionResultTask response
get
/sites/establish200 IActionResultTask response
{ }
Get a remote site by ID.
Parameters
id
string
Required
The remote site id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 RemoteSiteResponse response
404 A remote site with the specified ID does not exist.
get
/sites/{id}200 RemoteSiteResponse response
{}
],
}
},
},
}
},
}
}
Update a remote site.
Parameters
id
string
Required
The remote site id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated remote site.
| connected null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
|
|
|
|
| disabled null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| ip_address null |
string
<= 45 characters
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| status_updated_on null |
string <date-time>
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 RemoteSiteResponse response
404 A remote site with the specified ID does not exist.
put
/sites/{id}{}
},
}
200 RemoteSiteResponse response
{}
],
}
},
},
}
},
}
}
Patch a remote site.
Parameters
id
string
Required
The remote site id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated remote site.
| connected null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
|
|
|
|
| disabled null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| ip_address null |
string
<= 45 characters
|
|
|
|
| links null |
Links
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| status_updated_on null |
string <date-time>
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 RemoteSiteResponse response
404 A remote site with the specified ID does not exist.
patch
/sites/{id}{}
},
}
200 RemoteSiteResponse response
{}
],
}
},
},
}
},
}
}
Download package configuration for given remote site
Parameters
id
string
Required
The remote site id.
platform
string
"\"windows\""
"linux"
"osx"
"unknown"
"windows"
The client platform (e.g. windows, osx, or linux).
Responses
200 IActionResultTask response
404 A job profile with the specified ID does not exist.
get
/sites/{id}/download200 IActionResultTask response
{ }
List available account maps
This method will allow you to page all account maps.
Parameters
siteid
string
Required
The remote site id
platform
Comma Separated
string
The connection platform name.
source
Comma Separated
string
The source connection platform name.
destination
Comma Separated
string
The destination connection platform name.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
features
Comma Separated
string
The connection platform features.
connection
string
The source/destination connection id.
account
string
The source/destination connection account.
item
string
The source/destination platform item id.
path
string
The source/destination platform item path.
sourceconnection
string
The source connection id.
sourceaccount
string
The source connection account.
sourceitem
string
The source platform item id.
sourcepath
string
The source platform item path.
sourcetype
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
destinationconnection
string
The destination connection id.
destinationaccount
string
The destination connection account.
destinationitem
string
The destination platform item id.
destinationpath
string
The destination platform item path.
destinationtype
string
"directory"
"metadata"
The destination type.
type
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AccountMapsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps200 AccountMapsResponse response
{}
],
}
],
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Add account map.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/account_maps{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Gets a template for creating new account maps.
Parameters
siteid
string
Required
The remote site id
Responses
200 AccountMapTemplateResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps/new200 AccountMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Gets a template for creating new account maps.
Parameters
siteid
string
Required
The remote site id
Request Body
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapTemplateResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/account_maps/new{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Get a account map by ID.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps/{id}200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Update account map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
503 The remote site was not connected.
put
/v1/sites/{siteid}/api/account_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
Patch account map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated account map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
AccountMapItem
|
|
|
|
| exceptions null |
AccountException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
AccountMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 AccountMapResponse response
404 A account map with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/account_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
200 AccountMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
}
}
List exceptions in account map
This method will allow you to page all exceptions within an account map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExceptionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps/{id}/exceptions200 AccountExceptionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
}
}
Modify exceptions in an account map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
Request Body
| destination null |
Account
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Account
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/account_maps/{id}/exceptions[]
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
Delete exception in an account map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
exception
integer <int64>
Required
The exception id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/account_maps/{id}/exceptions/{exception}List destination exclusions in account map
This method will allow you to page all destination exclusions within an account map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExclusionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps/{id}/exclusions/destination200 AccountExclusionsResponse response
{}
],
}
],
}
}
],
}
},
}
},
}
},
}
}
Modify destination exclusions in an account map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/account_maps/{id}/exclusions/destination[]
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
List source exclusions in account map
This method will allow you to page all source exclusions within an account map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 AccountExclusionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/account_maps/{id}/exclusions/source200 AccountExclusionsResponse response
{}
],
}
],
}
}
],
}
},
}
},
}
},
}
}
Modify source exclusions in an account map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/account_maps/{id}/exclusions/source[]
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
Delete exclusion in an account map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The account map id.
exclusion
integer <int64>
Required
The exclusion id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/account_maps/{id}/exclusions/{exclusion}List available application job executions.
Parameters
siteid
string
Required
The remote site id
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/applications/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
List available job executions for the specified application.
This method will allow you to page all job executions posted by an application
Parameters
siteid
string
Required
The remote site id
id
string
Required
The application id.
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/applications/{id}/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
List established connections
This method will allow you to page all established connections.
Parameters
siteid
string
Required
The remote site id
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConnectionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections200 ConnectionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Adds a new connection.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/connections{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Delete all matched connections.
If query information is provided, then it will delete all connections that match a given query.
Parameters
siteid
string
Required
The remote site id
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/connectionsList all available storage platforms.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
active
boolean
A flag to indicate whether to only return enabled or disabled platforms.
source
boolean
A hint of the transfer direction to further limit connection platforms to only source-enabled platforms.
destination
boolean
A hint of the transfer direction to further limit connection platforms to only destination-enabled platforms.
preferred
boolean
A flag to indicate whether to only return the current user's preferred platforms.
features
string
The connection platform features.
Responses
200 StoragePlatformsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/platforms200 StoragePlatformsResponse response
{}
],
}
],
}
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
}
}
Get connection platform by name.
Parameters
siteid
string
Required
The remote site id
platform
string
Required
The storage platform name.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 StoragePlatformResponse response
404 A storage platform with the specified name does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/platforms/{platform}200 StoragePlatformResponse response
{}
],
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
}
}
Add new connection to storage platform.
Parameters
siteid
string
Required
The remote site id
platform
string
Required
The storage platform name.
name
string
The connection name.
redirect
string
The URI to redirect to after connection added.
format
string
The response format.
client_id
string
The client_id parameter.
client_secret
string
The client_secret parameter.
client_domain
string
The client_domain parameter.
admin_mode
boolean
"false"
type
string
"oauth"
"oauth2"
"prompt"
A hint to determine how authentication should be established to platform.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AuthorizeResponse response
302 Redirects to storage platform for external authentication.
404 A connection platform with the specified name does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/platforms/{platform}/new200 AuthorizeResponse response
{}
],
}
},
},
}
},
}
},
},
}
}
List accounts for a specific connection.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccountsResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/accounts200 AccountsResponse response
{}
],
}
],
}
],
}
},
}
},
}
},
}
}
Gets specific account by id for a specific connection.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
account
string
Required
The account id.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 AccountResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/accounts/{account}200 AccountResponse response
{}
],
}
},
],
}
},
}
},
}
},
}
}
Retrieve metadata for a specific file.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
path
string
The path to the file.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/files200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Retrieve metadata for a specific file.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
id
string
Required
The file ID.
path
string
The file path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the file ID does not exist.
405 The storage platform does not support loading by a file ID.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/files/{id}200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Retrieve metadata for a specific folder.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
path
string
The folder path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/folders200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
path
string
The folder path.
name
string
The new folder name.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new folder name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/connections/{connection}/folders{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Retrieve metadata for a specific folder.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
id
string
Required
The folder ID.
path
string
The folder path.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the folder ID does not exist.
405 The storage platform does not support loading by a folder ID.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/folders/{id}200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Add new folder
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
id
string
Required
path
string
The parent folder path.
name
string
The new folder name.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
X-Created-At
string
The created-on timestamp.
X-Created-By
string
The user to use to create the new folder.
Request Body
The request body with the new folder.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/connections/{connection}/folders/{id}{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Rename folder
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
id
string
Required
The folder ID.
name
string
The new folder name.
path
string
The folder path.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Request Body
The request body with the new folder name.
| access null |
AccessRuleSet
|
|
|
|
| accessed_by null |
Account
|
|
|
|
| accessed_on null |
string <date-time>
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| bytes null |
integer <int64>
|
|
|
|
| caption null |
string
|
|
|
|
| checkout_by null |
Account
|
|
|
|
| checkout_on null |
string <date-time>
|
|
|
|
| content_accessed_on null |
string <date-time>
|
|
|
|
| content_checkout_on null |
string <date-time>
|
|
|
|
| content_created_on null |
string <date-time>
|
|
|
|
| content_modified_on null |
string <date-time>
|
|
|
|
| content_type null |
string
|
|
|
|
| created_by null |
Account
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| etag null |
string
|
|
|
|
| features null |
ItemFeatures
|
|
|
|
| hash null |
string
|
|
|
|
| id null |
string
|
|
|
|
| is_hidden null |
boolean
|
|
|
|
| is_shared null |
boolean
|
|
|
|
| is_system null |
boolean
|
|
|
|
| items null |
Item
|
|
|
|
| links null |
Links
|
|
|
|
| metadata null |
ItemMetadata
|
|
|
|
| modified_by null |
Account
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
|
|
|
|
| owner null |
Account
|
|
|
|
| parent null |
Item (object)
|
|
|
|
| platform_type null |
ItemType
|
|
|
|
| root null |
boolean
|
|
|
|
| size_estimate null |
EstimatedItemSize
|
|
|
|
| sort null |
integer <int32>
|
|
|
|
| type null |
string
|
|
|
|
| version null |
string
|
|
|
|
| versions null |
ItemVersion
|
|
|
|
Responses
200 ItemResponse response
404 A connection with the specified ID does not exist or the specified Path does not exist.
405 The storage platform does not support loading by a folder ID.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/connections/{connection}/folders/{id}{}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
200 ItemResponse response
{}
],
}
},
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
List groups for a specific connection.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 GroupsResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/groups200 GroupsResponse response
{}
],
}
],
}
},
}
},
}
}
Gets specific group by id for a specific connection.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
group
string
Required
The group id.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 GroupResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/groups/{group}200 GroupResponse response
{}
],
}
},
},
}
},
}
}
List folders and files for a specific connection.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
path
string
If present, will list folders and files within the specific path.
type
string
"containers"
"files"
"folders"
"items"
If present, can filter items by type (i.e. folders and files)
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemsResponse response
404 A connection with the specified ID does not exist or if ?path present then the specified Path does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/items200 ItemsResponse response
{}
],
}
],
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
List folders and files for a specific folder ID.
The storage platform must support loading by folder ID in order to call this method.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
The connection id.
id
string
Required
The folder ID.
type
string
"containers"
"files"
"folders"
"items"
If present, can filter items by type (i.e. folders and files)
path
string
The folder path.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ItemsResponse response
404 A connection with the specified ID does not exist or the folder or file ID does not exist.
405 The storage platform does not support loading by a folder ID.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{connection}/items/{id}200 ItemsResponse response
{}
],
}
],
}
},
]
}
}
},
}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
],
},
}
},
},
}
}
}
}
}
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
},
]
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
},
],
}
},
}
},
}
},
],
}
},
}
},
}
},
}
}
Adds a connection to a connection pool.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
| id null |
string
|
|
|
|
| name null |
string
|
|
|
|
Responses
200 ConnectionResponse response
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/connections/{connection}/pool{}
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Removes a connection from its connection pool.
Parameters
siteid
string
Required
The remote site id
connection
string
Required
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/connections/{connection}/poolGet a connection by ID.
Returns the specified connection. A connection to the storage platform will be opened prior to being returned if one or more of the following conditions is met. * ?fields=auth is included in request query string.
* ?fields=features is included in request query string.
* ?fields=profile is included in request query string.
* ?test is included in request query string.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The connection id.
fields
Comma Separated
string
Attribute(s) to include in the response
test
boolean
"false"
If true then the connection will be opened prior to being returned.
X-Connect-As
string
The user to impersonate as when opening the connection.
X-Connect-Uri
string
The url to use when opening the connection.
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/connections/{id}200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Update a connection by ID.
In almost all regards, this method performs the same operation as a PATCH. There are few notible exceptions: * If ?reauthenticate is passed then the connection will attempt to refresh the authentication details.
* If ?enable is passed then the connection will be re-enabled.
* If ?disable is passed then the connection will be disabled.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The connection id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
put
/v1/sites/{siteid}/api/connections/{id}{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Patch a connection by ID.
Patches a connection based on the properties included in the response: * If the name property is included, then the connection will be renamed.
* If the auth property is included, then the authentication details for the connection will be validated and updated.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The connection id.
reauthenticate
boolean
"false"
enable
boolean
"false"
disable
boolean
"false"
fields
Comma Separated
string
Attribute(s) to include in the response
X-Connect-As
string
The user to impersonate when reauthenticating the connection.
X-Connect-Uri
string
The url to use when reauthenticating the connection.
Request Body
The connection details.
| account null |
Account
|
|
|
|
| allowed_types null |
ItemSupportedTypes
|
|
|
|
| auth null |
Authentication
|
|
|
|
| browse null |
boolean
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| disabled null |
boolean
|
|
|
|
| features null |
ConnectionFeatures
|
|
|
|
| group null |
boolean
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| links null |
Links
|
|
|
|
| load_strategy null |
ItemLoadStrategy
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| path null |
PathFeatures
|
|
|
|
| platform null |
StoragePlatform
|
|
|
|
| pool null |
ConnectionPool
|
|
|
|
| type null |
string
|
|
|
|
Responses
200 ConnectionResponse response
404 A connection with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/connections/{id}{}
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
200 ConnectionResponse response
{}
],
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
}
}
Gets audit logs for all convention jobs.
Parameters
siteid
string
Required
The remote site id
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/conventions/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/conventions/{id}/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job execution.
Parameters
siteid
string
Required
The remote site id
id
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ConventionAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/conventions/{id}/executions/{execution}/auditing200 ConventionAuditEntriesResponse response
{}
],
}
],
}
},
}
}
Gets audit logs for a specific convention job execution in comma-delimited text format
Parameters
siteid
string
Required
The remote site id
id
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResultTask response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/conventions/{id}/executions/{execution}/auditing.csv200 CsvOutputResultTask response
{ }
Gets available predefined filter groups.
Parameters
siteid
string
Required
The remote site id
Responses
200 PredefinedFilterGroupsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/filters/groups200 PredefinedFilterGroupsResponse response
{}
],
}
],
}
]
}
},
}
}
Gets a template for creating new content filters.
Parameters
siteid
string
Required
The remote site id
source
string
The source connection or platform ID.
destination
string
The destination connection or platform ID.
Responses
200 TransferFilterTemplateResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/filters/new200 TransferFilterTemplateResponse response
{}
],
}
},
},
],
}
]
}
}
],
}
]
}
},
}
}
List available group maps
This method will allow you to page all group maps.
Parameters
siteid
string
Required
The remote site id
platform
Comma Separated
string
The connection platform name.
source
Comma Separated
string
The source connection platform name.
destination
Comma Separated
string
The destination connection platform name.
group
string
"cloud"
"custom"
"on-premise"
"specialty"
"unspecified"
The connection platform locality.
features
Comma Separated
string
The connection platform features.
connection
string
The source/destination connection id.
account
string
The source/destination connection account.
item
string
The source/destination platform item id.
path
string
The source/destination platform item path.
sourceconnection
string
The source connection id.
sourceaccount
string
The source connection account.
sourceitem
string
The source platform item id.
sourcepath
string
The source platform item path.
sourcetype
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
destinationconnection
string
The destination connection id.
destinationaccount
string
The destination connection account.
destinationitem
string
The destination platform item id.
destinationpath
string
The destination platform item path.
destinationtype
string
"directory"
"metadata"
The destination type.
type
string
"control_endpoint"
"control_file"
"custom"
"directory"
"file"
The source type.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 GroupMapsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps200 GroupMapsResponse response
{}
],
}
],
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Add group map.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/group_maps{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Gets a template for creating new group maps.
Parameters
siteid
string
Required
The remote site id
Responses
200 GroupMapTemplateResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps/new200 GroupMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Gets a template for creating new group maps.
Parameters
siteid
string
Required
The remote site id
Request Body
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapTemplateResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/group_maps/new{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapTemplateResponse response
{}
],
}
},
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Get a group map by ID.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps/{id}200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Update group map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
503 The remote site was not connected.
put
/v1/sites/{siteid}/api/group_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
Patch group map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated group map.
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| destination null |
GroupMapItem
|
|
|
|
| exceptions null |
GroupException
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| ldap null |
LdapSearch
|
|
|
|
| links null |
Links
|
|
|
|
| map_by null |
SecurityMapFeatures
|
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| script null |
string
|
|
|
|
| source null |
GroupMapItem
|
|
|
|
| type null |
string
|
|
|
|
| unmapped_policy null |
string
"add" "default" "ignore" "warn"
|
|
|
|
Responses
200 GroupMapResponse response
404 A group map with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/group_maps/{id}{}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
200 GroupMapResponse response
{}
],
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
}
List exceptions in group map
This method will allow you to page all exceptions within an group map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExceptionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps/{id}/exceptions200 GroupExceptionsResponse response
{}
],
}
],
}
},
},
}
}
},
}
},
}
}
Modify exceptions in an group map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
Request Body
| destination null |
Group
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Group
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/group_maps/{id}/exceptions[]
}
},
},
}
}
},
}
200 IActionResultTask response
{ }
Delete exception in an group map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
exception
integer <int64>
Required
The exception id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/group_maps/{id}/exceptions/{exception}List destination exclusions in group map
This method will allow you to page all destination exclusions within an group map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExclusionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps/{id}/exclusions/destination200 GroupExclusionsResponse response
{}
],
}
],
}
}
},
}
},
}
}
Modify destination exclusions in an group map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Group
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/group_maps/{id}/exclusions/destination[]
}
}
},
}
200 IActionResultTask response
{ }
List source exclusions in group map
This method will allow you to page all source exclusions within an group map.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 GroupExclusionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/group_maps/{id}/exclusions/source200 GroupExclusionsResponse response
{}
],
}
],
}
}
},
}
},
}
}
Modify source exclusions in an group map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
Request Body
| id null |
integer <int64>
|
|
|
|
| sid null |
Group
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/group_maps/{id}/exclusions/source[]
}
}
},
}
200 IActionResultTask response
{ }
Delete exclusion in an group map
Parameters
siteid
string
Required
The remote site id
id
string
Required
The group map id.
exclusion
integer <int64>
Required
The exclusion id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/group_maps/{id}/exclusions/{exclusion}List available jobs
This method will allow you to page all jobs.
Parameters
siteid
string
Required
The remote site id
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Add job.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/jobs{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Patch jobs.
Parameters
siteid
string
Required
The remote site id
start
boolean
"false"
A flag to indicate that the job should be started.
cancel
boolean
"false"
A flag to indicate that the job should be cancelled.
pause
boolean
"false"
A flag to indicate that the job should be paused.
resume
boolean
"false"
A flag to indicate that the job should be resumed.
reset
string
A flag to indicate that the job state should be reset.
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobsResponse response
404 A job with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/jobs200 ScheduledJobsResponse response
{}
],
}
],
}
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Delete all matched jobs.
If query information is provided, then it will delete all jobs that match a given query.
Parameters
siteid
string
Required
The remote site id
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/jobsList available job history
This method will allow you to page all job history.
Parameters
siteid
string
Required
The remote site id
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/history200 JobExecutionsResponse response
{}
],
}
],
}
},
},
},
},
}
}
Gets a list of job template types.
Parameters
siteid
string
Required
The remote site id
Responses
200 ScheduledJobDescriptionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/new200 ScheduledJobDescriptionsResponse response
{}
],
}
],
}
},
}
}
Gets a template for creating a new job.
Parameters
siteid
string
Required
The remote site id
type
string
Required
Responses
200 NewScheduledJobTemplateResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/new/{type}200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a new job.
Parameters
siteid
string
Required
The remote site id
type
string
Required
Request Body
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 NewScheduledJobTemplateResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/jobs/new/{type}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Get a job by ID.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Update a job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
503 The remote site was not connected.
put
/v1/sites/{siteid}/api/jobs/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Patch a job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
start
boolean
"false"
A flag to indicate that the job should be started.
cancel
boolean
"false"
A flag to indicate that the job should be cancelled.
pause
boolean
"false"
A flag to indicate that the job should be paused.
resume
boolean
"false"
A flag to indicate that the job should be resumed.
reset
string
A flag to indicate that the job state should be reset.
Request Body
The updated job.
| convention null |
FolderMappingConventionOptions
|
|
|
|
| links null |
Links
|
|
|
|
| retention null |
RetentionOptions
|
|
|
|
| schedule null |
Schedule
|
|
|
|
| stop_policy null |
JobStopPolicy
|
|
|
|
| transfer null |
TransferTemplateOptions
|
|
|
|
| type null |
string
|
|
|
|
| category null |
JobCategory
|
|
|
|
| created_by null |
string
<= 40 characters
|
|
|
|
| created_on null |
string <date-time>
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| disabled null |
boolean
|
|
|
|
| execute_on null |
string <date-time>
|
|
|
|
| execution null |
JobExecution
|
|
|
|
| id null |
string
<= 40 characters
Required
|
|
|
|
| kind null |
string
<= 30 characters
Required
FolderMappingConventionJob |
|
|
|
| modified_by null |
string
<= 40 characters
|
|
|
|
| modified_on null |
string <date-time>
|
|
|
|
| name null |
string
<= 2000 characters
Required
|
|
|
|
| parent_id null |
string
<= 40 characters
|
|
|
|
| permissions null |
string
"cancel" "delete" "edit" "none" "pause" "reschedule" "start"
|
|
|
|
| previous_execution null |
JobExecution
|
|
|
|
| priority null |
integer <int32>
|
|
|
|
| scheduler null |
JobScheduler
|
|
|
|
| status null |
string
"awaiting-user" "cancel" "complete" "deleted" "failed" "idle" "none" "not-complete" "not-deleted" "paused" "resume" "running" "start" "success" "warn"
|
|
|
|
Responses
200 ScheduledJobResponse response
404 A job with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/jobs/{id}{}
},
],
},
},
},
}
},
],
},
}
],
}
},
},
]
}
}
},
}
]
}
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
]
}
}
],
}
},
}
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
]
},
},
},
}
},
},
],
}
]
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
],
}
},
},
}
}
},
}
},
},
}
},
}
},
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
},
}
]
}
}
},
}
},
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
]
}
},
}
}
],
}
],
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
]
}
}
},
}
]
}
}
},
},
},
}
},
}
},
}
}
}
}
},
}
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
],
},
],
}
},
}
},
}
}
},
},
}
},
},
},
},
},
},
},
},
}
},
},
},
],
}
},
}
},
}
},
],
}
},
},
}
]
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
},
}
],
],
],
},
},
}
},
},
],
}
},
},
},
},
},
},
},
},
},
},
},
},
},
},
},
}
},
}
},
}
],
],
],
},
},
}
},
},
],
}
},
}
},
}
},
},
},
},
}
},
},
},
}
}
}
},
},
},
},
},
},
},
},
},
},
},
}
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Create a new job by cloning an existing job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
JSON override options.
Responses
200 ScheduledJobResponse response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/jobs/{id}/clone"string"
200 ScheduledJobResponse response
{}
],
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
Gets a template for creating a editing an existing job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
Responses
200 NewScheduledJobTemplateResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}/edit200 NewScheduledJobTemplateResponse response
{}
],
}
},
],
}
},
}
],
}
},
}
},
},
},
},
},
},
},
}
},
},
},
},
},
},
},
},
},
},
},
}
},
},
}
},
},
}
}
List available history for specified job
This method will allow you to page job history for specified job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionsResponse response
404 A job with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}/history200 JobExecutionsResponse response
{}
],
}
],
}
},
},
},
},
}
}
Get current execution for specified job
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}/history/current200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
Get last execution for specified job
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}/history/last200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
Get specified execution for specified job
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
execution
integer <int64>
Required
The execution id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 JobExecutionResponse response
404 Either the job or the execution does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/jobs/{id}/history/{execution}200 JobExecutionResponse response
{}
],
}
},
},
},
},
},
}
}
List available application job executions.
Parameters
siteid
string
Required
The remote site id
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/profiles/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
List available job executions for the specified application.
This method will allow you to page all job executions posted by all applications associated with the specified profile.
Parameters
siteid
string
Required
The remote site id
id
string
Required
active
boolean
A flag to determine if result should only include active jobs.
categories
Comma Separated
integer <int64>
The job category.
kinds
Comma Separated
string
The job types.
exclude_kinds
Comma Separated
string
The job types to exclude.
exclude_id
string
The job ID to exclude.
modified_on
string
The modified date-range.
parent_id
string
The parent job.
exclude_children
boolean
A flag to determine if result should include child jobs.
job_status
Comma Separated
string
"awaiting-user"
"cancel"
"complete"
"deleted"
"failed"
"idle"
"none"
"not-complete"
"not-deleted"
"paused"
"resume"
"running"
"start"
"success"
"warn"
The job status.
running
boolean
A flag to determine if result should include running jobs.
paused
boolean
A flag to determine if result should include paused jobs.
failed
boolean
A flag to determine if result should include failed jobs.
schedulers
Comma Separated
integer <int64>
The job scheduler.
executed_on
string
The executed date-range.
jobs
Comma Separated
string
The jobs to include.
summary
Comma Separated
string
Optional summary of executions.
convention.added
< anything >
convention.removed
< anything >
convention.skipped
< anything >
critical
< anything >
destination.batches
< anything >
destination.batches_pending
< anything >
destination.bytes
< anything >
destination.changes
< anything >
destination.deleted
< anything >
destination.files
< anything >
destination.files_pending
< anything >
destination.folders
< anything >
destination.locked
< anything >
destination.metadata_import
< anything >
destination.permissions_import
< anything >
destination.rate_limits
< anything >
destination.renamed
< anything >
destination.unlocked
< anything >
destination.versions
< anything >
destination.versions_pending
< anything >
failures
< anything >
source.batches
< anything >
source.batches_pending
< anything >
source.bytes
< anything >
source.changes
< anything >
source.deleted
< anything >
source.files
< anything >
source.files_pending
< anything >
source.folders
< anything >
source.locked
< anything >
source.rate_limits
< anything >
source.renamed
< anything >
source.unlocked
< anything >
source.versions
< anything >
source.versions_pending
< anything >
client_id
string
Client id filter.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 AgentJobExecutionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/profiles/{id}/history200 AgentJobExecutionsResponse response
{}
],
}
],
}
},
},
}
},
},
}
}
siteapi_transfersauditlog_portalarchitects.transfers.services.v1.transfersauditlogcontroller.list (portalarchitects.transfers.services)
Parameters
siteid
string
Required
The remote site id
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
List or search for available categories.
Parameters
siteid
string
Required
The remote site id
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 TransferAuditCategoriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/categories200 TransferAuditCategoriesResponse response
{}
],
}
],
}
},
]
}
},
}
}
Add a new category.
Parameters
siteid
string
Required
The remote site id
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The new category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 No category provided with request.
409 A category with the same name already exists.
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/transfers/categories{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Delete categories that match specified criteria.
Parameters
siteid
string
Required
The remote site id
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/transfers/categoriesGet category by id.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditCategoryResponse response
404 A category with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/categories/{id}200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Update category.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The updated category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 A category was not provided with the request.
404 A category with the specified ID does not exist.
503 The remote site was not connected.
put
/v1/sites/{siteid}/api/transfers/categories/{id}{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
Patch category.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The category id.
fields
Comma Separated
string
Attribute(s) to include in the response
Request Body
The patched category.
| action null |
string
"halt" "ignore" "retry"
|
|
|
|
| description null |
string
<= 2000 characters
|
|
|
|
| filter null |
TransferAuditCategoryFilter
|
|
|
|
| id null |
string
<= 40 characters
|
|
|
|
| level null |
string
Required
"debug" "Default" "error" "info" "none" "trace" "warn"
|
|
|
|
| max_retry null |
integer <int64>
|
|
|
|
| name null |
string
<= 255 characters
Required
|
|
|
|
| priority null |
integer <int64>
|
|
|
|
Responses
200 TransferAuditCategoryResponse response
400 A category was not provided with the request.
404 A category with the specified ID does not exist.
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/transfers/categories/{id}{}
},
]
}
200 TransferAuditCategoryResponse response
{}
],
}
},
},
]
}
},
}
}
List or search for transfer items.
Parameters
siteid
string
Required
The remote site id
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/items200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
List or search for flagged transfer items.
Parameters
siteid
string
Required
The remote site id
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/items/flagged200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Export flagged transfer items to CSV.
Parameters
siteid
string
Required
The remote site id
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResult response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/items/flagged.csv200 CsvOutputResult response
{ }
Gets the transfer item for a specified ID.
Parameters
siteid
string
Required
The remote site id
itemid
integer <int64>
Required
The transfer item ID.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemResponse response
404 A transfer item with the specified ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/items/{itemid}200 TransferItemResponse response
{}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Modify the status of a transfer item give a specified ID.
Parameters
siteid
string
Required
The remote site id
itemid
integer <int64>
Required
The transfer item ID.
status
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The transfer item status.
ignore
boolean
Ignore the specified transfer item.
retry
boolean
Retry the specified transfer item.
recurse
boolean
Apply status change to transfer item and all children.
Responses
200 TransferItemResponse response
503 The remote site was not connected.
patch
/v1/sites/{siteid}/api/transfers/items/{itemid}200 TransferItemResponse response
{}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Gets audit logs for a specific job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
Gets transfer items for a specified job.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
parent_job
string
The parent job ID.
job
Comma Separated
string
The job IDs to include in the response.
status
Comma Separated
string
"none"
"pending"
"processed"
"remediation"
"retry"
"skipped"
"success"
The item status to include in the response.
parent
integer <int64>
The parent item ID.
item_id
string
The source/destination platform ID.
item_name
string
The source/destination platform name.
source_id
string
The source platform ID.
source_name
string
The source platform name.
destination_id
string
The destination platform ID.
destination_name
string
The destination platform name.
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferItemsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/items200 TransferItemsResponse response
{}
],
}
],
}
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
List exceptions in personal drive convention
This method will allow you to page all exceptions within a personal drive convention.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 PersonalDriveExceptionsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/exceptions200 PersonalDriveExceptionsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
},
}
}
Modify exceptions in a personal drive convention
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
Request Body
| destination null |
Account
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| source null |
Account
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/exceptions[]
}
},
],
}
},
}
},
}
}
],
}
},
}
},
}
200 IActionResultTask response
{ }
Delete exception in a personal drive convention
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
exception
integer <int64>
Required
The exception id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/exceptions/{exception}List include/exclude matches in personal drive convention
This method will allow you to page all include/exclude within a personal drive convention.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
q
string
A query string for searching items.
Responses
200 PersonalDriveMatchsResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/matches200 PersonalDriveMatchsResponse response
{}
],
}
],
}
},
],
}
},
}
},
}
},
}
}
Modify include/exclude matches in personal drive convention
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
Request Body
| category null |
string
<= 380 characters
|
|
|
|
| destination_convention null |
string
<= 500 characters
|
|
|
|
| id null |
integer <int64>
|
|
|
|
| sid null |
Account
|
|
|
|
| source_uri null |
string
<= 500 characters
|
|
|
|
Responses
200 IActionResultTask response
503 The remote site was not connected.
post
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/matches[]
}
},
],
}
},
}
},
}
200 IActionResultTask response
{ }
Delete include/exclude match in a personal drive convention
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job id.
match
integer <int64>
Required
The match id.
Responses
200
503 The remote site was not connected.
delete
/v1/sites/{siteid}/api/transfers/{id}/personal_drives/matches/{match}Lists all available transfer statistics.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
range
string
The date range of timeline entries.
limit
integer <int32>
The maximum number of timeline entries.
Responses
200 TransferStatisticsListResponse response
404 The specified job ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/stats200 TransferStatisticsListResponse response
{}
],
}
},
},
}
},
}
},
}
},
}
},
}
},
}
]
}
},
}
},
}
},
}
}
Provides access to transfer statistics by category.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
Responses
200 TransferCategoryStatisticsResponse response
404 The specified job ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/stats/by_category200 TransferCategoryStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics by status.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
Responses
200 TransferStatusStatisticsResponse response
404 The specified job ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/stats/by_status200 TransferStatusStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics by processing qualification.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
Responses
200 TransferProcessingStatisticsResponse response
404 The specified job ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/stats/processing200 TransferProcessingStatisticsResponse response
{}
],
}
},
}
},
}
},
}
}
Provides access to transfer statistics timeline.
Parameters
siteid
string
Required
The remote site id
id
string
Required
The job ID.
range
string
The date range of timeline entries.
limit
integer <int32>
The maximum number of timeline entries.
Responses
200 TransferStatusStatisticsTimelinesResponse response
404 The specified job ID does not exist.
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{id}/stats/timeline200 TransferStatusStatisticsTimelinesResponse response
{}
],
}
],
}
},
}
},
}
},
}
}
Gets audit logs for a specific job execution.
Parameters
siteid
string
Required
The remote site id
job
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 TransferAuditEntriesResponse response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{job}/executions/{execution}/auditing200 TransferAuditEntriesResponse response
{}
],
}
],
}
},
},
},
]
}
},
},
],
}
},
}
},
}
},
},
],
}
},
}
},
}
},
}
}
siteapi_transfersauditlog_portalarchitects.transfers.services.v1.transfersauditlogcontroller.byexecutionascsv (portalarchitects.transfers.services)
Parameters
siteid
string
Required
The remote site id
job
string
Required
execution
integer <int64>
Required
q
string
A query string for searching items.
offset
integer <int64>
The offset at which to begin the response.
limit
integer <int64>
The maximum number of items to return in a page.
fields
Comma Separated
string
Attribute(s) to include in the response
Responses
200 CsvOutputResultTask response
503 The remote site was not connected.
get
/v1/sites/{siteid}/api/transfers/{job}/executions/{execution}/auditing.csv200 CsvOutputResultTask response
{ }