Page History

GetResourceProperty

Usage:
HTTP_Resource_Manager_Services('GetResourceProperty', URLEndpoint, PropertyName)

Comments:
Gets Returns the value of the resource item from a database table. The format will be HAL+JSON.indicated resource property for the indicated URL endpoint.

Returns:
A database row in HAL+JSON format.

SetResourceProperty

Usage:
HTTP_Resource_Manager_Services('SetResourceProperty', URLEndpoint, PropertyName, PropertyValue)

Comments:
Gets the resource items from a database table. The format will be HAL+JSON.Sets (or updates) the value of the indicated resource property for the indicated URL endpoint.

Returns:
Database rows in HAL+JSON format.

GetResourceChildren

Usage:
HTTP_Resource_Manager_Services('GetResourceChildren', URLEndpoint, ChildType)

Comments:
Deletes the resource item from a database tableReturns an @FM delimited list of URL endpoints matching the indicated child type that are children to the indicated URL endpoint.

Returns:
N/A

GetResourceSignature

Usage:
HTTP_Resource_Manager_Services('GetResourceSignature', URLEndpoint, Method)

Comments:
Creates a new or updates a specific resource item in the database table. To conform to the requirements of the PUT method, the entire resource will be replaced with the content being passed in, even if only a few properties (e.g., database columns) are being updated. Thus, it is assumed that both changed and unchanged properties will be passed into the request bodyReturns the API calling signature for the indicated URL endpoint. This is used by the RunWebAPI service (a member of HTTP_Services) when calling the Web API module.

Returns:
N/A

GetEndpointResourceKeyID

Usage:
HTTP_Resource_Manager_Services('GetEndpointResourceKeyID', URLEndpoint, AllowNew)

Comments:
Creates a new resource item in the database table. To conform to the requirements of the POST method, the Key ID will be created automatically by the server and the entire resource will be created with the content being passed inReturns the resource Key ID for the indicated URL endpoint. If AllowNew is true, a URL endpoint will be returned that best matches the available endpoints but it will not be cached.

Returns:
N/A

GetResource

Usage:
HTTP_Resource_Manager_Services('GetResource', URLEndpoint)

Comments:
Updates a specific resource item in the database table. To conform to the requirements of the PATCH method, only specific properties (e.g., database columns) of the resource will be updated. All properties not identified will be left aloneReturns an array of resource property names and values for the indicated URL endpoint.

Returns:
N/A

SetResource

Usage:
HTTP_Resource_Manager_Services('SetResource', URLEndpoint, PropertyArray)

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:

Updates the array of resource property names and values for the indicated URL endpoint. Note, this replaces the existing property names and values. Other services should be used to update an existing array and then call this service when the array is updated. The PropertyArray must have at least one property name and value.

Returns:
An @FM delimited list of database column names.

IsValidEndpoint

Usage:
HTTP_Resource_Manager_Services('IsValidEndpoint', URLEndpoint)

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 a Boolean flag indicating if the indicated URL endpoint exists.

Returns:
An @FM delimited list of database column values for a specific Key ID.

GetResourceList

Usage:
HTTP_Resource_Manager_Services('GetResourceList')

Comments:
Gets the MV group names for the dictionary columns passed in. Note: the ColumnNames argument should be the same list that was returned from the GetColumnNames service. This will return an @FM delimited list of MV group names. Thus, for non-multivalue fields, the values will be empty. The MV group names will be returned in lower case. 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 valuesReturns the resource list for the current application.

Returns:
An @FM delimited list of MV group names.