Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ServiceDescription
GetDatabaseItem

Usage:
HTTP_Resource_Services('GetDatabaseItem', TableName, SelfURL, ItemID, ColumnNames, ItemArrayLabel)

Comments:
Gets the resource item from a database table. The format will be HAL+JSON.

Returns:
N/AA database row in HAL+JSON format.

GetDatabaseItems

Usage:
HTTP_Resource_Services('GetDatabaseItems', Filter, TableName, SelfURL, ColumnNames, ItemArrayLabel)

Comments:
Gets the resource item items from a database table. The format will be HAL+JSON.

Returns:
N/ADatabase rows in HAL+JSON format.

DeleteDatabaseItem

Usage:
HTTP_Resource_Services('DeleteDatabaseItem', TableName, ItemID)

Comments:
Deletes the resource item from a database table.

Returns:
N/A

PostDatabaseItem

Usage:
HTTP_Resource_Services('PostDatabaseItem', TableName, SelfURL, ItemID)

Comments:
Creates a new or updates a specific resource item in the database table. If a specific resource item is being updated then only the data columns specified will be updated. A PUT will replace the entire resource item.

Returns:
N/A

GetColumnNames

Usage:
HTTP_Resource_Services('GetColumnNames', TableName, ColumnNames)

Comments:
Gets the column names from the dictionary of the table provided that will be used to create the resource. If the ColumnNames argument is used then this service will validate the list as valid columns. In either case, the following rules will be applied:

  • Regardless of the case used to in the ColumnNames argument it will be upper cased to match against the dictionary names correctly.
  • All column names will be returned in lower case.
  • All column names bound to a Key ID of part 0 (i.e., the entire key) will be removed.
  • All non-master column names will be removed to avoid duplicates.
  • SRP FrameWorks audit column names (MODIFIED_BY, MODIFIED_DATE, and MODIFIED_TIME) will be removed.

Returns:
A serialized HAL+JSON object based based on the current HAL objects in memoryAn @FM delimited list of database column names.

GetColumnValues

Usage:
HTTP_Resource_Services('GetColumnValues', TableName, ColumnNames, ItemID)

Comments:
Gets the column values from the database row from the provided table and ID that will be used to create the resource. This is returned as an @FM delimited list of values.

Returns:
Handle to a root Schema+JSON objectAn @FM delimited list of database column values for a specific Key ID.

Param1 - Param10

The proper use of the generic arguments are defined in the definition of each service above.