Sample URI request by table ID
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)Tables(<TableId>)
If no <TableId> is passed, the API retrieves all the available tables in the Smart Reference Data database server.
Example URI to retrieve all the attributes: https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)Tables
Headers
Header name |
Description |
Required |
Values |
---|---|---|---|
Authorization |
Access token |
Required |
Bearer <access_token> |
Content-Type |
Request type format |
Required |
application/json |
Get URI Parameter
Parameter |
Description |
Type |
Required |
TableID |
The table id to which you want to retrieve the data |
Integer |
Required |
Response
Element |
Description |
Type |
Notes |
---|---|---|---|
TableId |
A unique ID for the table. |
Integer |
Generated by the software |
Project |
The project or product group from where the table is retrieved. |
String |
|
TableName |
Name of the table |
String |
|
TableTypeId |
A unique ID for the table type. |
Integer |
Generated by the software |
TableType |
Identifies the table type which the current table is assigned to. |
String |
|
NlsId |
Language identifier |
Integer |
Required |
ShortDescription |
Short description of the table |
String |
Required |
Description |
Description of the table |
String |
Required |
Sample response
{
"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/Tables",
"value": [
{
"TableId": 6061,
"Project": "SDB",
"TableName": "M_A60_COUNT",
"TableTypeId": 5021,
"TableType": "PHYSICAL",
}
]
}
Sample URI request by table name
GET https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/Tables/<Name Space>.ExistsTableName(TableName='TAB)')/
Element |
Description |
Type |
Notes |
---|---|---|---|
ExistsTableName |
Name of the function to retrieve table by name |
String |
|
TableName |
Name of the function parameter that is passed to retrieve a specific table name |
String |
Example: TableName='TAB' retrieves all the table names that starts with the characters TAB and their numeric extension. |
The following table shows the supported special characters for a table name:
Special character |
Supported character |
Notes |
---|---|---|
- |
Same as |
|
: |
Same as |
|
. |
Same as |
|
_ |
Same as |
|
? |
Replace with %3F |
Example: TableName='TAB%3F' |
$ |
Same as |
|
/ |
Replace with ! |
This character can be configured in Web.config file. Example: <appSettings> <add key="SpecialCharacterFwdSlash" value="!" /> </appSettings> |
, |
Same as |
|
+ |
Replace with ; |
This character can be configured in Web.config file. <appSettings> <add key="SpecialCharacterPlus" value=";" /> </appSettings> |
[ |
Same as |
|
] |
Same as |
|
( |
Same as |
|
) |
Same as |
|
= |
Same as |
|
> |
Same as |
|
ß |
Same as |
|
& |
Same as |
|
* |
Same as |
|
" |
Same as |
|
Blank |
Same as |
|
Umlauts |
Same as |
Sample response
{
"@odata.context": "https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Collection(Com.Ingr.Srd.V1.Table)",
"value": [
{
"TableId": 12471,
"Project": "SDB",
"TableName": "TAB",
"TableTypeId": 5022,
"TableType": "COMMATTR",
},
{
"TableId": 12261,
"Project": "SDB",
"TableName": "TAB_1",
"TableTypeId": 5182,
"TableType": "GEOM_S5021",
}
]
}