Specific method requests for IMS™
The File Manager Service Provider accepts the following JSON for specific method requests for IMS™ data.
{
"operation" :
{
"numSegments" : integer,
"session" : Boolean,
"token" : "string"
},
"position" :
{
"segmentKeys" :
[
{
"segmentName" : "string",
"keyValue" : "string",
"operator" : "string"
}
]
}
}
Key fields for specific method requests are explained in the following table:
| Key | Description |
|---|---|
| operation | Operation parameters affect the behavior of the service provider. All operation parameters are optional, but for performance reasons it is helpful to understand the correct use of the session and token parameters. |
| numSegments | The number of database segments to retrieve. The acceptable range is 0 - 10000. The default is 1. |
| session | Indicates whether to persist or end a File Manager/IMS session. A value of true instructs the service provider to start the session (if it is not already started) and keep it active for subsequent API calls. A value of false instructs the service provider to end the session when the API call is complete. |
| token | A session token, as returned in a previous API response. The token represents an active FM/IMS session and can be used for subsequent reads following an
initial read that sets "session" : true. A successful initial read request with
"session" : true returns a token in the response. |
| position | Position parameters affect the read position within the IMS™ database. Positioning requires knowledge of the name of and hierarchical path to the relevant database segments and the length of the segment keys. Positioning occurs before the read request is satisfied. |
| segmentKeys | An array of database segment names and associated key values. Specify array elements in database hierarchical order. Note that the last segment listed in the array will be the segment that is positioned on. |
| segmentName | The name of the database segment to position on or after. |
| keyValue | The required value for the segment’s key to position on or after. |
| operator | Logical operator for positioning based on segment/key value elements in the segmentKeys
array. The operator can be EQ (equal) or GE (greater than or equal). The default is EQ. The operator parameter only takes effect when it is specified on the last element of the segmentKeys array (that is, the segment that is being positioned on) but applies to all segment/key value assignments that are specified in the array.
|