Cloud Services

ModernOps configuration

APIs for RateCard/SPClients_V2
Published On Oct 28, 2024 - 4:09 PM

APIs for RateCard/SPClients_V2

Learn what the RateCard/SP Clients_V2 APIs are and what they are used for.
The following are the Ratecard/SPClients_V2 APIs, including parameters, and what they are used for.
API:
GET/shared/ratecard/spclients
Used for:
Getting list of clients
Parameters
Name
Description
offset
integer
(query)
The first record of the page. Default is set to 0.
Default value : 0
limit
integer
(query)
The number of records on the page. Default is set to 20.
Default value : 20
sort_order
string
(query)
Sort the records in ascending or descending order. The default order is asc. Allowed values: asc or desc.
Available values : asc, desc
Default value : asc
sort_by
string
(query)
Sorting the records can be applied on specific field. Default value is asc.
Available values : name, client_id, updated_at, updated_by, created_at, created_by
Default value : name
Response content type: application/json
Parameters
Code
Description
200
Success
Example Value |
Model
{
  "limit": 20,
  "offset": 0,
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ],
  "results": [
    {
      "applicable_for": [
        {
          "id": "string",
          "label": "string",
          "sequence": 0,
          "values": [
            {
              "id": "string",
              "label": "string"
            }
          ]
        }
      ],
      "base_url": "string",
      "certs": "string",
      "client_id": "string",
      "client_type": "string",
      "created_at": "2023-05-15T18:52:11.176Z",
      "created_by": "string",
      "customersTenants": [
        "tenant1"
      ],
      "description": "string",
      "name": "string",
      "updated_at": "2023-05-15T18:52:11.176Z",
      "updated_by": "string"
    }
  ],
  "size": 0,
  "sort_by": "name",
  "sort_order": "asc"
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
Client Not found
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
500
Internal Server Error
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
API:
POST/shared/ratecard/spclients
Used for:
Creating a new client
Parameters
Name
Description
payload *
required
object
(body)
Example Value |
Model
{
  "applicable_for": [
    {
      "id": "string",
      "label": "string",
      "sequence": 0,
      "values": [
        {
          "id": "string",
          "label": "string"
        }
      ]
    }
  ],
  "base_url": "string",
  "certs": "string",
  "client_id": "string",
  "created_at": "2023-05-15T18:58:09.222Z",
  "created_by": "string",
  "customersTenants": [
    "tenant1"
  ],
  "description": "string",
  "name": "string",
  "updated_at": "2023-05-15T18:58:09.222Z",
  "updated_by": "string"
}
Parameter content type:
application/json
Response content type: application/json
Responses
Code
Description
201
Success
Example Value |
Model
{
  "applicable_for": [
    {
      "id": "string",
      "label": "string",
      "sequence": 0,
      "values": [
        {
          "id": "string",
          "label": "string"
        }
      ]
    }
  ],
  "base_url": "string",
  "certs": "string",
  "client_id": "string",
  "created_at": "2023-05-15T18:58:09.269Z",
  "created_by": "string",
  "customersTenants": [
    "tenant1"
  ],
  "description": "string",
  "name": "string",
  "updated_at": "2023-05-15T18:58:09.269Z",
  "updated_by": "string"
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
409
Conflict: Client already exists
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
500
Internal Server Error
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
API:
DELETE/shared/ratecard/spclients/{client_id}
Used for:
Deleting a specified client
Parameters
Name
Description
client_id *
string
(path)
client_id
Response content type: application/json
Responses
Code
Description
200
Success
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
Not Found
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
API:
GET/shared/ratecard/spclients/{client_id}
Used for:
Getting details for a specified client
Parameters
Name
Description
client_id *
string
(path)
client_id
Response content type: application/json
Responses
Code
Description
200
Success
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ],
  "result": {
    "applicable_for": [
      {
        "id": "string",
        "label": "string",
        "sequence": 0,
        "values": [
          {
            "id": "string",
            "label": "string"
          }
        ]
      }
    ],
    "base_url": "string",
    "certs": "string",
    "client_id": "string",
    "client_type": "string",
    "created_at": "2023-05-15T19:09:09.221Z",
    "created_by": "string",
    "customersTenants": [
      "tenant1"
    ],
    "description": "string",
    "name": "string",
    "updated_at": "2023-05-15T19:09:09.221Z",
    "updated_by": "string"
  }
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
Client Not Found
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
API:
PATCH/shared/ratecard/spclients/{client_id}
Used for:
Patching a specified client
Parameters
Name
Description
payload *
required
object
(body)
Example Value |
Model
{
  "array_filters": [
    {}
  ],
  "data": {}
}
action
string
(query)
What kind of update action are you performing
Available values : set, pull, push
Default value : set
client_id *
required
string
(path)
client_id
Response content type: application/json
Responses
Code
Description
200
Success
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
Not Found
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
API:
PUT/shared/ratecard/spclients/{client_id}
Used for:
Updating provided client
Parameters
Name
Description
payload *
required
object
(body)
Example Value |
Model
{
  "applicable_for": [
    {
      "id": "string",
      "label": "string",
      "sequence": 0,
      "values": [
        {
          "id": "string",
          "label": "string"
        }
      ]
    }
  ],
  "base_url": "string",
  "certs": "string",
  "client_id": "string",
  "created_at": "2023-05-15T19:23:46.954Z",
  "created_by": "string",
  "customersTenants": [
    "tenant1"
  ],
  "description": "string",
  "name": "string",
  "updated_at": "2023-05-15T19:23:46.954Z",
  "updated_by": "string"
}
Parameter content type:
application/json
client_id *
required
string
(path)
client_id
Responses
Code
Description
200
Success
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
Not Found
Example Value |
Model
{
  "reasons": [
    {
      "id": "oidhwd",
      "messages": [
        "Successfully retrieved the ratecards"
      ],
      "status": "OK",
      "statusCode": 100,
      "translateCode": "RC_2002_GET_ALL_RATECARD",
      "translateParameters": [
        "string"
      ]
    }
  ]
}
Do you have two minutes for a quick survey?
Take Survey