

Operation ID | Description |
| List the object keys in the specified collection in alphabetical order |
| Search for objects that match the specified filter criteria (returns metadata, not actual objects) |
| Get the bytes for the specified object |
| Put the specified new object at the given key or overwrite an existing object at the given key |
| Delete the specified object |
| Get the metadata for the specified object |
List the object keys in the specified collection in alphabetical order
list
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
collection_name |  |  | path | string | The name of the collection |
end |  |  | query | string | The end key to end listing to |
limit |  |  | query | integer | The limit of results to return |
parameters |  |  | query | dictionary | Full query string parameters payload in JSON format. |
start |  |  | query | string | The start key to start listing from |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.list(end="string",
limit=integer,
start="string",
collection_name="string"
)
print(response)
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ListObjects(end="string",
limit=integer,
start="string",
collection_name="string"
)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ListObjects",
end="string"
limit=integer,
start="string",
collection_name="string"
)
print(response)
Search for objects that match the specified filter criteria (returns metadata, not actual objects)
search
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects |
- Consumes: application/octet-stream
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
collection_name |  |  | path | string | The name of the collection |
filter |  |  | query | string | The filter to limit the returned results. |
limit |  |  | query | integer | The limit of results to return |
offset |  |  | query | integer | The offset of results to return |
parameters |  |  | query | dictionary | Full query string parameters payload in JSON format. |
sort |  |  | query | string | The sort order for the returned results. |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.search(filter="string",
limit=integer,
offset=integer,
sort="string",
collection_name="string"
)
print(response)
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.SearchObjects(filter="string",
limit=integer,
offset=integer,
sort="string",
collection_name="string"
)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("SearchObjects",
filter="string",
limit=integer,
offset=integer,
sort="string",
collection_name="string"
)
print(response)
Get the bytes for the specified object
get
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects/{object_key} |
- Consumes: application/json
- Produces: application/octet-stream
Name | Service | Uber | Type | Data type | Description |
collection_name |  |  | path | string | The name of the collection |
object_key |  |  | path | string | The object key |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "wb", encoding="utf-8") as save_file:
save_file.write(falcon.get(collection_name="string", object_key="string"))
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "wb", encoding="utf-8") as save_file:
save_file.write(falcon.GetObject(collection_name="string", object_key="string"))
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "wb", encoding="utf-8") as save_file:
save_file.write(falcon.command("GetObject", collection_name="string", object_key="string"))
Put the specified new object at the given key or overwrite an existing object at the given key
upload
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects/{object_key} |
- Consumes: application/octet-stream
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
body |  |  | body | string | The object to be uploaded in binary format. |
collection_name |  |  | path | string | The name of the collection. |
dry_run |  |  | query | boolean | If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it. |
object_key |  |  | path | string | The object key. |
parameters |  |  | query | dictionary | Full query string parameters payload in JSON format. |
schema_version |  |  | query | string | The version of the collection schema. |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "rb") as upload_file:
response = falcon.upload(body=upload_file.read(),
collection_name="string",
dry_run=boolean,
object_key="string",
schema_version="string"
)
print(response)
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "rb") as upload_file:
response = falcon.PutObject(body=upload_file.read(),
collection_name="string",
dry_run=boolean,
object_key="string",
schema_version="string"
)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("some_file.ext", "rb") as upload_file:
response = falcon.command("PutObject",
body=upload_file.read(),
collection_name="string",
dry_run=boolean,
object_key="string",
schema_version="string"
)
print(response)
Delete the specified object
delete
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects/{object_key} |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
collection_name |  |  | path | string | The name of the collection |
dry_run |  |  | query | boolean | If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it. |
object_key |  |  | path | string | The object key |
parameters |  |  | query | dictionary | Full query string parameters payload in JSON format. |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.delete(collection_name="string", object_key="string", dry_run=boolean)
print(response)
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.DeleteObject(collection_name="string", object_key="string", dry_run=boolean)
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("DeleteObject",
collection_name="string",
object_key="string",
dry_run=boolean
)
print(response)
Get the metadata for the specified object
metadata
Method | Route |
 | /customobjects/v1/collections/{collection_name}/objects/{object_key}/metadata |
- Consumes: application/json
- Produces: application/json
Name | Service | Uber | Type | Data type | Description |
collection_name |  |  | path | string | The name of the collection |
object_key |  |  | path | string | The object key |
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.metadata(collection_name="string", object_key="string")
print(response)
from falconpy import CustomStorage
falcon = CustomStorage(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetObjectMetadata(collection_name="string", object_key="string")
print(response)
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetObjectMetadata", collection_name="string", object_key="string")
print(response)