S3
AWS S3 synchronization operations
Returns the capability of the file system with the specified ID. Deprecated: use GET /genericIntegration/{ingestibleId}/capability.
Id of attached Edge capability
No capability attached
GET /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/capability HTTP/1.1
Authorization: Basic username:password
Accept: */*
123e4567-e89b-12d3-a456-426614174000Adds a capability to the file system with the specified ID. Deprecated: use PUT /genericIntegration/{ingestibleId}/capability.
Capability attached
No content
PUT /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/capability HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 38
"123e4567-e89b-12d3-a456-426614174000"Capability attached
No content
Removes a capability from the file system with the specified ID. Deprecated: use DELETE /genericIntegration/{ingestibleId}/capability.
Capability detached
No content
DELETE /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/capability HTTP/1.1
Authorization: Basic username:password
Accept: */*
Capability detached
No content
Find filesystem assets that have the given Edge capability attached (Deprecated: use GET /genericIntegration?capabilityId=)
Filesystem asset ids
GET /rest/catalog/1.0/filesystem HTTP/1.1
Authorization: Basic username:password
Accept: */*
Filesystem asset ids
[
"123e4567-e89b-12d3-a456-426614174000"
]Returns a list of crawlers that are defined for the file system with the specified ID. Deprecated: use GET /genericIntegration/{ingestibleId}/crawlers.
Success
GET /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/crawlers HTTP/1.1
Authorization: Basic username:password
Accept: */*
Success
[
{
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"includePaths": [
{
"path": "text",
"excludePatterns": [
"text"
]
}
],
"fileSystemId": "123e4567-e89b-12d3-a456-426614174000",
"domainId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifiers": [
"text"
],
"tableLevel": 1,
"targets": "text",
"fileGroupPattern": "text"
}
]Adds a new crawler definition to the file system with the specified ID. Deprecated: use POST /genericIntegration/{ingestibleId}/crawlers.
Must match the {assetId} path parameter. The server validates both values match and returns HTTP 400 if they differ.
Success
POST /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/crawlers HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 324
{
"name": "text",
"includePaths": [
{
"path": "text",
"excludePatterns": [
"text"
]
}
],
"fileSystemAssetId": "123e4567-e89b-12d3-a456-426614174000",
"domainId": "123e4567-e89b-12d3-a456-426614174000",
"assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifiers": [
"text"
],
"tableLevel": 1,
"targets": "text",
"fileGroupPattern": "text"
}Success
{
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"includePaths": [
{
"path": "text",
"excludePatterns": [
"text"
]
}
],
"fileSystemId": "123e4567-e89b-12d3-a456-426614174000",
"domainId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifiers": [
"text"
],
"tableLevel": 1,
"targets": "text",
"fileGroupPattern": "text"
}Updates a crawler definition for the file system with the specified ID. Deprecated: use PUT /genericIntegration/{ingestibleId}/crawlers.
Success
PUT /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/crawlers HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 316
{
"name": "text",
"includePaths": [
{
"path": "text",
"excludePatterns": [
"text"
]
}
],
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"domainId": "123e4567-e89b-12d3-a456-426614174000",
"assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifiers": [
"text"
],
"tableLevel": 1,
"targets": "text",
"fileGroupPattern": "text"
}Success
{
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"includePaths": [
{
"path": "text",
"excludePatterns": [
"text"
]
}
],
"fileSystemId": "123e4567-e89b-12d3-a456-426614174000",
"domainId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifiers": [
"text"
],
"tableLevel": 1,
"targets": "text",
"fileGroupPattern": "text"
}Deletes a crawler definition from the file system with the specified ID. Deprecated: prefer DELETE /filesystem/{fileSystemType}/{assetId}/crawlers/{crawlerId} which identifies the crawler via the path instead of the request body.
Must match the {assetId} path parameter. The server validates both values match and returns HTTP 400 if they differ.
Crawler deleted
No content
DELETE /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/crawlers HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 164
{
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"fileSystemAssetId": "123e4567-e89b-12d3-a456-426614174000",
"assetTypeId": "123e4567-e89b-12d3-a456-426614174000"
}Crawler deleted
No content
Deletes a crawler by its ID. Deprecated: use DELETE /genericIntegration/{ingestibleId}/crawlers/{crawlerId}.
Crawler deleted
No content
DELETE /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/crawlers/{crawlerId} HTTP/1.1
Authorization: Basic username:password
Accept: */*
Crawler deleted
No content
Returns the synchronization schedule for the file system with the specified ID. Deprecated: use GET /genericIntegration/{ingestibleId}/schedule.
cloud synchronization schedule
A JSON-encoded string representing the UI preset selection, persisted inside the JobRunr recurring job payload. Returned so the UI can reconstruct the preset on load. Null when a custom cron expression is used. Structure: {"preset":"daily|weekly|monthly","fields":{"dayOfTheWeek":<1-7>,"hours":<0-23>}}
{"preset":"daily","fields":{"dayOfTheWeek":1,"hours":0}}GET /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/schedule HTTP/1.1
Authorization: Basic username:password
Accept: */*
cloud synchronization schedule
{
"id": 1,
"cronExpression": "text",
"cronTimeZone": "text",
"lastRunTimeStamp": 1,
"nextRunDateLongValue": 1,
"cronJson": "{\"preset\":\"daily\",\"fields\":{\"dayOfTheWeek\":1,\"hours\":0}}",
"workflow": "text"
}Adds a synchronization schedule for the file system with the specified ID. Deprecated: use POST /genericIntegration/{ingestibleId}/schedule.
Cloud synchronization schedule added
A JSON-encoded string representing the UI preset selection, persisted inside the JobRunr recurring job payload. Returned so the UI can reconstruct the preset on load. Null when a custom cron expression is used. Structure: {"preset":"daily|weekly|monthly","fields":{"dayOfTheWeek":<1-7>,"hours":<0-23>}}
{"preset":"daily","fields":{"dayOfTheWeek":1,"hours":0}}POST /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/schedule HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"fileSystemAssetId": "123e4567-e89b-12d3-a456-426614174000",
"cronExpression": "text",
"cronTimeZone": "text",
"cronJson": "text"
}Cloud synchronization schedule added
{
"id": 1,
"cronExpression": "text",
"cronTimeZone": "text",
"lastRunTimeStamp": 1,
"nextRunDateLongValue": 1,
"cronJson": "{\"preset\":\"daily\",\"fields\":{\"dayOfTheWeek\":1,\"hours\":0}}",
"workflow": "text"
}Updates a synchronization schedule for the file system with the specified ID. Deprecated: use PUT /genericIntegration/{ingestibleId}/schedule.
S3 synchronization schedule updated
A JSON-encoded string representing the UI preset selection, persisted inside the JobRunr recurring job payload. Returned so the UI can reconstruct the preset on load. Null when a custom cron expression is used. Structure: {"preset":"daily|weekly|monthly","fields":{"dayOfTheWeek":<1-7>,"hours":<0-23>}}
{"preset":"daily","fields":{"dayOfTheWeek":1,"hours":0}}New S3 synchronization schedule created
PUT /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/schedule HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"fileSystemAssetId": "123e4567-e89b-12d3-a456-426614174000",
"cronExpression": "text",
"cronTimeZone": "text",
"cronJson": "text"
}{
"id": 1,
"cronExpression": "text",
"cronTimeZone": "text",
"lastRunTimeStamp": 1,
"nextRunDateLongValue": 1,
"cronJson": "{\"preset\":\"daily\",\"fields\":{\"dayOfTheWeek\":1,\"hours\":0}}",
"workflow": "text"
}Deletes a synchronization schedule for the file system with the specified ID. Deprecated: use DELETE /genericIntegration/{ingestibleId}/schedule.
Cloud synchronization schedule deleted
No content
DELETE /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/schedule HTTP/1.1
Authorization: Basic username:password
Accept: */*
Cloud synchronization schedule deleted
No content
Starts an asynchronous Edge synchronization job for the file system or capability with the specified ID. Deprecated: use POST /genericIntegration/{ingestibleId}/run.
Cloud synchronization job successfully started
Represents a job. Job is a single atomic task that is to be performed asynchronously
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe type of the job.
IMPORTThe ID of the user that initiated this job.
The visibility of the job.
The progress percentage of the job.
50Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.
The start date of the job.
1488016800The end date of the job.
1488021800The state of the job.
COMPLETEDPossible values: The result of the job.
SUCCESSPossible values: The message of the job.
Import finished in 12s.POST /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/synchronize HTTP/1.1
Authorization: Basic username:password
Accept: */*
Cloud synchronization job successfully started
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
"createdOn": 1475503010320,
"lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
"lastModifiedOn": 1476703764163,
"system": true,
"name": "Test name",
"type": "IMPORT",
"userId": "123e4567-e89b-12d3-a456-426614174000",
"visibility": 1,
"progressPercentage": 50,
"cancelable": true,
"startDate": 1488016800,
"endDate": 1488021800,
"state": "COMPLETED",
"result": "SUCCESS",
"message": "Import finished in 12s."
}Schedule canceling of cloud synchronization (Deprecated: use DELETE /genericIntegration/{ingestibleId}/cancel)
No job to cancel
No content
DELETE /rest/catalog/1.0/filesystem/{fileSystemType}/{assetId}/synchronize HTTP/1.1
Authorization: Basic username:password
Accept: */*
No job to cancel
No content
Get the custom classifiers for S3 Glue crawler. Deprecated: read customClassifiers via GET /genericIntegration/{ingestibleId}/crawlers.
Content of custom classifiers
GET /rest/catalog/1.0/filesystem/s3/{assetId}/crawlers/{crawlerId} HTTP/1.1
Authorization: Basic username:password
Accept: */*
Content of custom classifiers
textSet the custom classifiers for S3 Glue crawler. Deprecated: set customClassifiers via PUT /genericIntegration/{ingestibleId}/crawlers.
Custom classifiers has been successfully set
No content
PATCH /rest/catalog/1.0/filesystem/s3/{assetId}/crawlers/{crawlerId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"crawlerId": "123e4567-e89b-12d3-a456-426614174000",
"customClassifierNames": [
"text"
]
}Custom classifiers has been successfully set
No content
Starts a Jobserver based synchronization job for the give S3 File System. Deprecated: Jobserver is legacy (EOL May 2027). Attach an Edge capability and use POST /genericIntegration/{ingestibleId}/run instead.
S3 File System identifier
S3 synchronization job successfully started
Represents a job. Job is a single atomic task that is to be performed asynchronously
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe type of the job.
IMPORTThe ID of the user that initiated this job.
The visibility of the job.
The progress percentage of the job.
50Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.
The start date of the job.
1488016800The end date of the job.
1488021800The state of the job.
COMPLETEDPossible values: The result of the job.
SUCCESSPossible values: The message of the job.
Import finished in 12s.Other synchronization for this s3FileSystemId is currently active
POST /rest/catalog/1.0/filesystem/s3/{assetId}/synchronize/jobserver HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
"createdOn": 1475503010320,
"lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
"lastModifiedOn": 1476703764163,
"system": true,
"name": "Test name",
"type": "IMPORT",
"userId": "123e4567-e89b-12d3-a456-426614174000",
"visibility": 1,
"progressPercentage": 50,
"cancelable": true,
"startDate": 1488016800,
"endDate": 1488021800,
"state": "COMPLETED",
"result": "SUCCESS",
"message": "Import finished in 12s."
}Last updated
Was this helpful?