Skip to content

Commit

Permalink
Update getTable.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cameroncaci authored Dec 1, 2023
1 parent 433f9e4 commit d90156e
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions docs/getTable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

`POST {ApiGatewayURL}/api/v1/getTable`

## Notice
It is strongly recommended to provide the contentUpdatedSinceDateTime in your request. Please leverage the last updated time within the database.

## Controller
[src/main/java/com/milmove/trdmlambda/milmove/controller/GetTableController.java](../src/main/java/com/milmove/trdmlambda/milmove/controller/GetTableController.java)

Expand All @@ -15,14 +12,41 @@ It is strongly recommended to provide the contentUpdatedSinceDateTime in your re

[Response Model](../src/main/java/com/milmove/trdmlambda/milmove/model/gettable/GetTableResponse.java)

## Example Requests

**README**: All date time requests are to be provided as strings in XMLGregorian format (Go's time.Time defaults to this). Booleans are to be provided as booleans.

### Request all data since a certain date time

Example
```
{
"physicalName": "{{TableName}}",
"contentUpdatedSinceDateTime":"{{now}}",
"physicalName": "LN_OF_ACCT",
"contentUpdatedSinceDateTime":"2023-11-03T12:29:57.040Z",
"returnContent": true
}
```

### Request all data for a specific date time range

Example
```
{
"physicalName": "LN_OF_ACCT",
"contentUpdatedSinceDateTime":"2023-11-03T12:29:57.040Z",
"returnContent": true,
"contentUpdatedOnOrBeforeDateTime": "2023-11-04T12:29:57.040Z"
}
```

### Optional Fields (Including not found in example)

`contentUpdatedOnOrBeforeDateTime` is an XMLGregorianCalendar time. When provided along with `contentUpdatedSinceDateTime`, our API will convert that to an `IS_ON_OR_AFTER` and

`IS_ON_OR_BEFORE` filter to retrieve data for the specified date range.

`returnRowStatus` is a boolean to return the status of the row from TRDM (Such as active or inactive).

`returnLastUpdate` is a boolean to return the last update with the request from TRDM.
#### HTTP Response Codes
`[200, 400, 500, 502]`
`[200, 400, 500, 502]`

0 comments on commit d90156e

Please sign in to comment.