curl --request GET \
--url https://app.octavehq.com/api/v2/resource/get \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"sourceType": "url",
"identifier": "<string>",
"workspaceOId": "<string>",
"isParentResource": true,
"isGlobal": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"metadata": {
"fieldwiseTaskIdentifier": "<string>",
"taskStatus": "pending",
"externalFilePath": "<string>",
"title": "<string>",
"description": "<string>",
"faviconUrl": "<string>",
"logoUrl": "<string>",
"statusCode": 123,
"isWorkspacePrimarySource": false,
"isMainResource": false,
"asyncCrawlComplete": true,
"originalFileName": "<string>",
"driveFileType": "file",
"driveFileUrl": "<string>",
"driveFileLastModifiedTime": "<string>"
},
"settings": {
"excludeFromReIndexing": true
},
"encodedData": "<string>",
"fieldwiseDocumentId": "<string>",
"status": "pending",
"lastIndexedAt": "<string>",
"hasChildren": true,
"totalChildren": 123,
"storageData": {
"taskStatus": "pending",
"fieldwiseTaskIdentifier": "<string>",
"filePath": "<string>",
"fieldwiseDocumentId": "<string>"
},
"uploadedByUserOId": "<string>"
}
}Get a resource by OId. Optionally check storage task status for pending/uploading resources.
curl --request GET \
--url https://app.octavehq.com/api/v2/resource/get \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"sourceType": "url",
"identifier": "<string>",
"workspaceOId": "<string>",
"isParentResource": true,
"isGlobal": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"metadata": {
"fieldwiseTaskIdentifier": "<string>",
"taskStatus": "pending",
"externalFilePath": "<string>",
"title": "<string>",
"description": "<string>",
"faviconUrl": "<string>",
"logoUrl": "<string>",
"statusCode": 123,
"isWorkspacePrimarySource": false,
"isMainResource": false,
"asyncCrawlComplete": true,
"originalFileName": "<string>",
"driveFileType": "file",
"driveFileUrl": "<string>",
"driveFileLastModifiedTime": "<string>"
},
"settings": {
"excludeFromReIndexing": true
},
"encodedData": "<string>",
"fieldwiseDocumentId": "<string>",
"status": "pending",
"lastIndexedAt": "<string>",
"hasChildren": true,
"totalChildren": 123,
"storageData": {
"taskStatus": "pending",
"fieldwiseTaskIdentifier": "<string>",
"filePath": "<string>",
"fieldwiseDocumentId": "<string>"
},
"uploadedByUserOId": "<string>"
}
}Resource OId
"res_abc123"
Whether to check and return the current Fieldwise storage task status
true