Versions Compared

Key

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

...

Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.

...

GET API/SLA/{ID}

This Uniform Contract operation is used to retrieve the representation of a managed entity or a task.
Note that collections can be retrieved via GET api/SLA with no {ID}
Description :

...

Retrieve sla with specified ID – only one SLA is returned:

  • GET /api/sla/1

...

PUT API/SLA/{ID}

This Uniform Contract operation is used to completely update the representation of a managed entity or a task.
Description :

...

REQUEST

PUT API/SLA/1
Content-type: application/json

{"sla": { JSON Resource Representation with every attributes }}

RESPONSE

201
Content-Type: application/json

{"sla": { JSON Resource Representation with every attributes }

...

PATCH API/SLA/{ID}

Description:

  • This Uniform Contract operation is used to partially update the representation of a SLA.
  • Resource represents a managed entity.

...

REQUEST

PATCH API/sla/{ID}
Content-type: application/json

{"sla": {
JSON Resource Representation with every attributes }}

RESPONSE

201
Content-Type: application/json

{"sla": { JSON Resource Representation with every attributes }}

 

...

POST API/SLA/{ID}

Description:

  • This Uniform Contract operation is used to create a SLA.
  • Resource represents a managed entity.
  • Mandatory attributes that must be provided when you create the SLA :

...

  • Further specify any rules on the creation of the entity

    Rule name

    Rule

     

     

     

     

    REQUEST

    POST API/sla
    Content-type: application/json

    {"sla": { JSON Resource Representation with every attributes ", }}

    RESPONSE

    201
    Content-Type: application/json

    {"sla": {
    JSON Resource Representation with every attributes }}

     

    Anchor_Toc404167103_Toc404167103

    DELETE API/SLA/{ID}

    This Uniform Contract operation is used to delete a managed entity or a task.
    Description :
  • Provide an overall description of the Operation
  • Describe if the resource represents a managed entity or a task.
  • Describe the structure of the identifier.

...

  • What status and exception codes are returned.
  • Returns HTTP/1.1 status code 200 if the request was successful.
  • Any other special return and/or exception codes.

    REQUEST

    DELETE API/SLA/{ID}

    RESPONSE

    200


    Example Anchor_Toc368488808_Toc368488808 see Example see TMF REST Design Guidelines.

    © TM Forum 2015. All Rights Reserved