Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

5.4.0

A pass-through API to ServiceScheduling (when configured) which allows the ServiceScheduling's "Get Responsibility Units" API to be called.

Description

The sp:GetRespUnitsRequest API method returns a set of responsibility units in the array RespUnits.


In this context, the ServiceScheduling "Get Responsibility Units" API is the sp:GetRespUnitsRequest API.  

On this page:

Related pages:

Resource URL Summary

Pass Through Call to ServiceScheduling'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 ServiceScheduling's "Get Responsibility Units" API

This RESTified API will perform a pass-through call to the ServiceScheduling 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 ServiceScheduling "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)

PropertyTypeLengthDescriptionReq?Mapping Field: Service Scheduling
FRU

string

SS: 9

Pass through parameter to the ServiceScheduling 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 ServiceScheduling Get Responsibility Units API. 

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

Yes

PrevRespUnit

Optionsobject

Pass through parameter to the ServiceScheduling Get Responsibility Units API. 

No

see: GetResponsibilty.Options.Objects

HTTP Response

Success

On success, a JSON-formatted version of the ServiceScheduling "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 ServiceScheduling "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 ServiceScheduling API return codes, the possible Return Codes from this API are:

 Click here to expand...
  • SP_OK (0)
  • SP_UNIT_INVALID (28)









  • No labels