Resource URL Summary

Pass Through Call to Scheduling's "Get Responsibility Units" API

PUT /up/v5/rest/scheduling/GetRespUnits

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to Scheduling's "Get Responsibility Units" API

This RESTified API will perform a pass-through call to the Scheduling sub-system's "Get Responsibility Units" API (when configured).

URL

PUT /up/v5/rest/scheduling/GetRespUnits

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Scheduling "Get Responsibility Units" APi.

GetResponsibilityUnits Object Format

GetResponsibilityUnits JSON

{
    "FRU": "ParentRespUnit",
    "OffsetId": "PrevRespUnit",
    "Options": {
        "FRUCount": 1
    }
}

GetResponsibilityUnits Object Properties (bold property names indicate required field)

Property Type Length Description Req? Mapping Field: Service Scheduling

FRU

string

SS: 9

Pass through parameter to the Scheduling Get Responsibility Units API.

If this is not supplied, all Final Responsibility Units (FRUs) will be returned; if this is the ID of an FRU, all its constituent IRUs will be returned.

Yes

ParentRespUnit

OffsetUd

string

SS: 9

Pass through parameter to the Scheduling Get Responsibility Units API.

Is the start point for each batch; it should not be set for the first batch.

Yes

PrevRespUnit

Options

object

Pass through parameter to the Scheduling Get Responsibility Units API.

No

see: GetResponsibilty.Options.Objects

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "Get Responsibility Units" API response will be returned.

{
    "Success": true,
    "Code": "0",
    "Message": "",
    "Payload": {
        "result": {
            "type": "OK",
            "code": "0"
        },
    "OffsetId": "PrevRespUnit",
    "OffsetCount": "RespUnitCount",
    "FRUs": [
        {FRU}
    ]
  }
}

Error

On error, a JSON-formatted version of the Scheduling "Get Responsibility Units" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "code": "SCH Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the Scheduling API return codes, the possible Return Codes from this API are:

Click here to expand...

SP_OK (0)
SP_UNIT_INVALID (28)

ServiceBroker 5

GetResponsiblityUnits RESTified API

Analytics

Resource URL Summary

HTTP Headers

API Specifics

Pass Through Call to Scheduling's "Get Responsibility Units" API

URL

HTTP Request Body

GetResponsibilityUnits Object Format

GetResponsibilityUnits Object Properties (bold property names indicate required field)

Success

Return Codes

Related content