Skip to content

Commit 3fc35f5

Browse files
committed
docs: update example for requesting export
1 parent 740a294 commit 3fc35f5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ if (response.ok) {
4343
See [Datarock's Public API documentation](https://api-docs.prod.datarock.com.au/index.html) to understand the API interface and return values.
4444

4545
### Projects
46+
---
4647

4748
**ListProjectsCommand\<void\>: Promise\<Response\>**
4849

@@ -51,6 +52,7 @@ List projects asssociated with your account
5152
`new ListProjectsCommand()`
5253

5354
### Holes
55+
---
5456

5557
**ListHolesCommand\<{projectUuid}\>: Promise\<Response\>**
5658

@@ -61,6 +63,9 @@ const projectUuid = "some-uuid" // project uuids can be deduced from the ListPro
6163
new ListHolesCommand({projectUuid})
6264
```
6365

66+
### Exports
67+
---
68+
6469
**CreateExportCommand\<{projectUuid, holeIds, lastUpdatedSince, lastUpdatedBefore, artefactType}\>:
6570
Promise\<Response\>**
6671

@@ -69,6 +74,7 @@ Request an export for a set of holes, for a given resource.
6974
```
7075
const projectUuid = "some-uuid" // project uuids can be deduced from the ListProjectsCommand
7176
const artefactType = "depth_registration" // see Datarock API documentation for list of resources
77+
const holeIds = ["foo", "bar"] // can be deduced from the ListHolesCommand
7278
const lastUpdatedBefore = Date.now()
7379
const DAY_IN_MILLISECONDS = 24 * 60 * 60 * 1000
7480
// yesterday (not accounting for day light savings, etc)

0 commit comments

Comments
 (0)