Versions Compared

Key

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

...

ServiceDescription

GetResourceProperty

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

Comments:
Returns the value of the indicated resource property for the indicated URL endpoint.

Returns:
A database row in HAL+JSON formatSee comments.

SetResourceProperty


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

Comments:
Sets (or updates) the value of the indicated resource property for the indicated URL endpoint.

Returns:
Database rows in HAL+JSON format.N/A

GetResourceChildren


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

Comments:
Returns an @FM delimited list of URL endpoints matching the indicated child type that are children to the indicated URL endpoint.

Returns:
N/ASee comments.

GetResourceSignature

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

Comments:
Returns 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/ASee comments.

GetEndpointResourceKeyID


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

Comments:
Returns 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/ASee comments.

GetResource

Usage:
HTTP_Resource_Manager_Services('GetResource', URLEndpoint)

Comments:
Returns an array of resource property names and values for the indicated URL endpoint.

Returns:
N/ASee comments.

SetResource


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

Comments:
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.N/A

IsValidEndpoint


Usage:
HTTP_Resource_Manager_Services('IsValidEndpoint', URLEndpoint)

Comments:
Returns a Boolean flag indicating if the indicated URL endpoint exists.

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

GetResourceList

Usage:
HTTP_Resource_Manager_Services('GetResourceList')

Comments:
Returns the resource list for the current application.

Returns:
An @FM delimited list of MV group namesSee comments.

Params

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

...