TAMU Service Descriptions
| parameter | value | description |
|---|---|---|
props | JSONObject of the database properties to retrieve from each table | |
conds | JSONObject of the conditions under which to retrieve the data from lims | |
order | JSONObject of the ordering of the query | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
props | JSONObject of the database properties to retrieve from each table | |
conds | JSONObject of the conditions under which to retrieve the data from lims | |
order | JSONObject of the ordering of the query | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
field | The field name to retrieve values from | |
table | The table to retrieve values from | |
conds | JSONObject of the conditions under which to retrieve the data from lims | |
distinct | Boolean flag indicating whether or not the query should be distinct. True if not specified. | |
removeNulls | Boolean flag indicating whether or not null entries should be removed from the results. True if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
field | The field name to retrieve values from | |
table | The table to retrieve values from | |
conds | JSONObject of the conditions under which to retrieve the data from lims | |
distinct | Boolean flag indicating whether or not the query should be distinct. True if not specified. | |
removeNulls | Boolean flag indicating whether or not null entries should be removed from the results. True if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
props | string (required) | JSONObject of the database properties to retrieve from each table |
analysis | string (required) | Name of the analysis for which the query is made |
status | JSONArray of the status to query for | |
qaqcAnalysis | the name of the qaqc analysis to query for | |
ordering | JSONArray of JSONObects of JSONArrays describing the ordering of the results |
available response representations:
| parameter | value | description |
|---|---|---|
props | string (required) | JSONObject of the database properties to retrieve from each table |
analysis | string (required) | Name of the analysis for which the query is made |
status | JSONArray of the status to query for | |
qaqcAnalysis | the name of the qaqc analysis to query for | |
ordering | JSONArray of JSONObects of JSONArrays describing the ordering of the results |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
listName | string (required) | Name of the list for which the query is made |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
depthScale | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
depthScale | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
sampleType | Query sample_type | |
analysis | string (required) | Query analysis |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
depthScale | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
sampleType | Query sample_type | |
analysis | string (required) | Query analysis |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
depthScale | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | string (required) | Query analysis |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | string (required) | Query analysis |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | string (required) | XML query specification |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. |
available response representations:
| parameter | value | description |
|---|---|---|
testNumber | string (required) | test number to log result on |
componentName | string (required) | name of the component to log results for |
componentValue | string (required) | value to log for the specified component |
units | string (required) | units for the result |
replicateNumber | replicate number to log the results on, 0 for none. A null value will fill the next available replicate for the component | |
inSpec | indicates if a given value is in spec |
available response representations:
| parameter | value | description |
|---|---|---|
testNumber | string (required) | test number to log result on |
componentName | string (required) | name of the component to log results for |
componentValue | string (required) | value to log for the specified component |
units | string (required) | units for the result |
replicateNumber | replicate number to log the results on, 0 for none. A null value will fill the next available replicate for the component | |
inSpec | indicates if a given value is in spec |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
ids | string (required) | JSON Sample Numbers Array. |
table | string (required) |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
ids | string (required) | JSON Sample Numbers Array. |
table | string (required) |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
results | string (required) | JSON Results Array. Each results object has the following memebers: componentName, componentValue, units, testNumber, replicateNumber |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
results | string (required) | JSON Results Array. Each results object has the following memebers: componentName, componentValue, units, testNumber, replicateNumber |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
sample_number | string (required) | LIMS Sample Number |
source | string (required) | External Source |
key | string (required) | External Key |
value | string (required) | External Value |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | Username |
pass | string (required) | Password |
sample_number | string (required) | LIMS Sample Number |
source | string (required) | External Source |
key | string (required) | External Key |
value | string (required) | External Value |
available response representations:
| parameter | value | description |
|---|---|---|
tableName | string (required) | name of the table to update |
fieldName | string (required) | name of the field to update |
fieldValue | string (required) | value to update field to |
indexName | string (required) | field to restrict the update (where clause field) |
indexValue | string (required) | value to restrict the update (where clause value) |
debugOn | value to turn debug on/off |
available response representations:
| parameter | value | description |
|---|---|---|
tableName | string (required) | name of the table to update |
fieldName | string (required) | name of the field to update |
fieldValue | string (required) | value to update field to |
indexName | string (required) | field to restrict the update (where clause field) |
indexValue | string (required) | value to restrict the update (where clause value) |
debugOn | value to turn debug on/off |
available response representations:
| parameter | value | description |
|---|---|---|
tableName | string (required) | name of the table to update |
fieldMap | string (required) | map of field/value pairs to update |
indexName | string (required) | field to restrict the update (where clause field) |
indexValue | string (required) | value to restrict the update (where clause value) |
debugOn | value to turn debug on/off |
available response representations:
| parameter | value | description |
|---|---|---|
tableName | string (required) | name of the table to update |
fieldMap | string (required) | map of field/value pairs to update |
indexName | string (required) | field to restrict the update (where clause field) |
indexValue | string (required) | value to restrict the update (where clause value) |
debugOn | value to turn debug on/off |
available response representations:
| parameter | value | description |
|---|---|---|
testListName | string (required) | name of the test list to log |
sampleNumber | string (required) | sample to log the test list against |
available response representations:
| parameter | value | description |
|---|---|---|
sampleNumber | string (required) | sample number to log test on |
analysisName | string (required) | name of the analysis to log on the test |
variationName | name of the analysis to log on the test. an null value indicates no variation | |
instrumentName | name of the instrument logging the test. a null value indicates no instrument or the instrument set up in the LIMS analysis |
available response representations:
| parameter | value | description |
|---|---|---|
sampleNumber | string (required) | sample number to log test on |
analysisName | string (required) | name of the analysis to log on the test |
variationName | name of the analysis to log on the test. an null value indicates no variation | |
instrumentName | name of the instrument logging the test. a null value indicates no instrument or the instrument set up in the LIMS analysis |
available response representations:
| parameter | value | description |
|---|---|---|
expedition | Expedition (only required for hole) | |
site | Site (only required for hole) | |
scaleType | Scale type (SUMADVANCE, SUMOBSERVED). Only required for hole. | |
keepVoids | Should voids be kept. Only required for hole. | |
diameter | Diameter of the sample. Required for hole, core, section | |
sampleTool | Tool used to make the hole. Validated against SAMPTOOLS LIMS list | |
sampleType | string (required) | Sample type. Validated against SAMPLETYPE LIMS list |
sampleName | Name of the sample. Various conventions for different sample types. | |
comment | Comments | |
scaleAuthor | Author of the scale (for logging a hole). If not supplied defaults to the user. | |
scaleComments | Comments for the scale | |
scaleClass | Scale class override. Default (not supplied) is "CSF" | |
scaleUnits | Scale unit override. Default is meters | |
parentID | Sample number of the parent to the sample being logged | |
offset | Sample offset, in meters, from the parent sample | |
advancement | Drilling advancement. Only applies to a core | |
length | Length of the sample | |
autoSplit | Only applies to a section. Determines if a section should automatically log section halves. Default is false (T,F) | |
volume | Volume of the sample. If left off default is 0. | |
isSTD | Flag which indicates sample is a standard. (T,F). Only needed if a standard is being logged | |
expirationDate | Determines when a sample/standard expires. If not provided sample/standard will be left as null (non-expiring) | |
standardType | Determines what type of standard is being logged | |
latitude | Used for hole creation | |
longitude | Used for hole creation |
available response representations:
| parameter | value | description |
|---|---|---|
expedition | Expedition (only required for hole) | |
site | Site (only required for hole) | |
scaleType | Scale type (SUMADVANCE, SUMOBSERVED). Only required for hole. | |
keepVoids | Should voids be kept. Only required for hole. | |
diameter | Diameter of the sample. Required for hole, core, section | |
sampleTool | Tool used to make the hole. Validated against SAMPTOOLS LIMS list | |
sampleType | string (required) | Sample type. Validated against SAMPLETYPE LIMS list |
sampleName | Name of the sample. Various conventions for different sample types. | |
comment | Comments | |
scaleAuthor | Author of the scale (for logging a hole). If not supplied defaults to the user. | |
scaleComments | Comments for the scale | |
scaleClass | Scale class override. Default (not supplied) is "CSF" | |
scaleUnits | Scale unit override. Default is meters | |
parentID | Sample number of the parent to the sample being logged | |
offset | Sample offset, in meters, from the parent sample | |
advancement | Drilling advancement. Only applies to a core | |
length | Length of the sample | |
autoSplit | Only applies to a section. Determines if a section should automatically log section halves. Default is false (T,F) | |
volume | Volume of the sample. If left off default is 0. | |
isSTD | Flag which indicates sample is a standard. (T,F). Only needed if a standard is being logged | |
expirationDate | Determines when a sample/standard expires. If not provided sample/standard will be left as null (non-expiring) | |
standardType | Determines what type of standard is being logged | |
latitude | Used for hole creation | |
longitude | Used for hole creation |
available response representations:
| parameter | value | description |
|---|---|---|
sampleFields | sample fields |
available response representations:
| parameter | value | description |
|---|---|---|
sampleFields | sample fields |
available response representations:
| parameter | value | description |
|---|---|---|
user | string (required) | username |
pass | string (required) | password |
authenticationtype | authentication type (db, lims, dblims) |
available response representations:
| parameter | value | description |
|---|---|---|
sampleTextId | The TextID of the sample associated with depth maps | |
sampleName | The name of the sample associated with depth maps | |
exp | The expedition of the sample associated with depth maps | |
site | The site of the sample associated with depth maps |
available response representations:
| parameter | value | description |
|---|---|---|
sampleTextId | The TextID of the sample associated with depth maps | |
sampleName | The name of the sample associated with depth maps | |
exp | The expedition of the sample associated with depth maps | |
site | The site of the sample associated with depth maps |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
qaqc | Flag to indicate if QAQC analysis names should be shown or not. Not specifying this field will show all analysis names. Specifying it to false will eliminate the names of analyses in the QAQC group. Specifying it to true will show only those analyses in the QAQC group. |
available response representations:
| parameter | value | description |
|---|---|---|
analysis | Optional parameter specifying the analysis to get the instruments of. Not specifying this field will get instruments for all analyses. |
available response representations:
| parameter | value | description |
|---|---|---|
analysis | Optional parameter specifying the analysis to get the instruments of. Not specifying this field will get instruments for all analyses. |
available response representations:
| parameter | value | description |
|---|---|---|
analysis | string (required) | The analysis to get the components of. |
available response representations:
| parameter | value | description |
|---|---|---|
analysis | string (required) | The analysis to get the components of. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. | |
binIndex | The bin index for the RSC Raw data report. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. | |
binIndex | The bin index for the RSC Raw data report. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. |
available response representations:
| parameter | value | description |
|---|---|---|
sample | string (required) | The text id of the sample to calculate depth on. |
offset | string (required) | The offset in the sample to calculate depth at. |
available response representations:
| parameter | value | description |
|---|---|---|
holeid | The hole id to get the disturbances for. |
available response representations:
| parameter | value | description |
|---|---|---|
holeid | The hole id to get the disturbances for. |
available response representations:
| parameter | value | description |
|---|---|---|
sampleNumber | string (required) | The sample number to compute the offset in section for. |
available response representations:
| parameter | value | description |
|---|---|---|
sampleNumber | string (required) | The sample number to compute the offset in section for. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | string (required) | Query analysis |
components | string (required) | Comma-separated list of components to get from the analysis |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by | |
sampletype | Sample type to filter by | |
desctemplate | Descinfo template to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | string (required) | Query analysis |
components | string (required) | Comma-separated list of components to get from the analysis |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by | |
sampletype | Sample type to filter by | |
desctemplate | Descinfo template to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | string (required) | Query analysis |
components | string (required) | Comma-separated list of components to get from the analysis |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by | |
sampletype | Sample type to filter by | |
desctemplate | Descinfo template to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | string (required) | Query analysis |
components | string (required) | Comma-separated list of components to get from the analysis |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by | |
sampletype | Sample type to filter by | |
desctemplate | Descinfo template to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
analysis | string (required) | analysis to query |
expedition | string (required) | expedition to query |
available response representations:
| parameter | value | description |
|---|---|---|
sourcetest | string (required) | test to move |
destinationsample | string (required) | sample to move it to |
available response representations:
| parameter | value | description |
|---|---|---|
sourcesample | string (required) | sample to move |
newparent | string (required) | sample to move it to |
available response representations:
| parameter | value | description |
|---|---|---|
sourceresult | string (required) | result to move |
destinationtest | string (required) | test to move it to |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | Query analysis | |
components | Comma-separated list of components to get from the analysis | |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
exp | string (required) | Query leg |
site | Query site | |
hole | Query site | |
core | The name of the core | |
section | The name of the section | |
analysis | Query analysis | |
components | Comma-separated list of components to get from the analysis | |
minDepth | Minimum depth to search for | |
maxDepth | Maximum depth to search for | |
instrument | Instrument to filter by |
available response representations:
| parameter | value | description |
|---|---|---|
username | string (required) | username |
password | string (required) | password |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | Query leg | |
site | Query site | |
hole | Query site | |
holeTextId | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
depthScale | XML query specification | |
sampleType | Query sample_type | |
analysis | Query analysis | |
component | Query analysis | |
enteredBy | Query analysis | |
topDepth | Query analysis | |
bottomDepth | Query analysis | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
qaqc | A boolean flag to indicate whether the data is QAQC data or not. By default, this is false and the data returned is not QAQC data. | |
qaqcAndRpt | A boolean flag to indicate whether the data and QAQC data should be shown in one report. By default, this is false and the data returned is not QAQC data. | |
showIds | Boolean flag indicating whether or not the fields sample_number, test_number, and result_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
spliceId | Splice name | |
exp | XML query specification | |
site | XML query specification | |
hole | XML query specification | |
core | The name of the core | |
coreType | The type of the core | |
section | The name of the section | |
sectionHalf | The section half | |
holeTextId | XML query specification | |
depthScale | XML query specification | |
sampleType | XML query specification | |
topDepth | XML query specification | |
bottomDepth | XML query specification | |
requestNumber | XML query specification | |
requestCode | XML query specification | |
testList | XML query specification | |
returnType | The format of the results to return. Either XML, HTML, or WRS, XML if not specified. | |
showIds | Boolean flag indicating whether or not the field sample_number should be shown in the output. True if not specified. | |
separateReps | Boolean flag indicating whether or not the results should be organized by replicate count in the output. False if not specified. | |
maxResultCount | The maximum number of results to return. | |
drillingDisturbances | A comma separated list of drilling disturbance types to filter out. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. | |
binIndex | The bin index for the RSC Raw data report. |
available response representations:
| parameter | value | description |
|---|---|---|
exp | The expedition to get the navigation report for, defaults to the current one in LIMS if not specified. | |
site | The site to get the navigation report for, retrieves all if not specified. | |
hole | The hole to get the navigation report for, retrieves all if not specified. | |
core | The core to get the navigation report for, retrieves all if not specified. | |
section | The section to get the navigation report for, retrieves all if not specified. | |
report | string (required) | The report to get. |
minDate | The date to start the report on, gets the entire database contents if not specified. | |
maxDate | The date to end the report on, gets the entire database contents if not specified. | |
binIndex | The bin index for the RSC Raw data report. |
available response representations: