Origin groups
GET Origin Groups#
Get all origin groups of the distribution.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origingroups |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "originId": "string", "origins": "string", "originRoutingType": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| originId | string | "string" | Returns the name of origin that user gave |
| origins | string | "string" | Returns all the origins |
| originRoutingType | string | "string" | Returns the routing type which can be Round Robin, Fail over, Waited |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Origin Groups#
Create a new origin group
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origingroups |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | {distributionId, originGroupId, origins, id, randomRoutingPercentage, originOptions, id, value, originRoutingType } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
Request body#
{ "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| distributionId | Yes | string | "string" | Sends the identifier for the distribution |
| originGroupId | Yes | string | "string" | Sends the origin group name that user gave |
| origins | Yes | array [object] | Sends the origins | |
| id | No | integer($int32) | 0 | Sends the identifier of origin |
| randomRoutingPercentage | string | "string" | Sends integer strings | |
| originOptions | array [object] | Sends an origin options object | ||
| id | No | integer($int32) | 0 | Sends the identifier of origin |
| value | string | "string" | Sends the selected value of origin option object | |
| originRoutingType | integer($int32) | 0 | Sends the choosen routing type |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0, "originRoutingTypeOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| distributionId | string | "string" | Returns the identifier for the distribution |
| originGroupId | string | "string" | Returns the user input name of origin group |
| origins | string | "string" | Returns all the origins |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| originRoutingType | integer($int32) | 0 | Returns the chosen routing type |
| originRoutingTypeOptions | array [object] | Returns an object of all the options of origin routing type | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
GET Origin Group#
Get the specified origin group
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origingroups/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The certificates's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The certificates's ID |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0, "originRoutingTypeOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| distributionId | string | "string" | Returns the identifier for the distribution |
| originGroupId | string | "string" | Returns the user input name of origin group |
| origins | string | "string" | Returns all the origins |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| originRoutingType | integer($int32) | 0 | Returns the chosen routing type |
| originRoutingTypeOptions | array [object] | Returns an object of all the options of origin routing type | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Origin Groups#
Update the specified origin group.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origingroups/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId, id |
| Body | {distributionId, originGroupId, origins, id, randomRoutingPercentage, originOptions, id, value, originRoutingType} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The OriginGroup's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The OriginGroup's ID |
Request Body#
{ "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| distributionId | Yes | string | "string" | Sends the identifier for the distribution |
| originGroupId | Yes | string | "string" | Sends the origin group name that user gave |
| origins | Yes | array [object] | Sends the origins | |
| id | No | integer($int32) | 0 | Sends the identifier of origin |
| randomRoutingPercentage | string | "string" | Sends integer strings | |
| originOptions | array [object] | Sends an origin options object | ||
| id | No | integer($int32) | 0 | Sends the identifier of origin |
| value | string | "string" | Sends the selected value of origin option object | |
| originRoutingType | integer($int32) | 0 | Sends the choosen routing type |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0, "originRoutingTypeOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| distributionId | string | "string" | Returns the identifier for the distribution |
| originGroupId | string | "string" | Returns the user input name of origin group |
| origins | string | "string" | Returns all the origins |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| originRoutingType | integer($int32) | 0 | Returns the chosen routing type |
| originRoutingTypeOptions | array [object] | Returns an object of all the options of origin routing type | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
Delete the specified origin group
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/origingroups/{id} |
| Headers | Authorization |
| Parameters | distributionId, version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | The OriginGroup's ID |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The OriginGroup's ID |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{
"success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "originGroupId": "string", "origins": [ { "id": 0, "randomRoutingPercentage": 0 } ], "originOptions": [ { "id": 0, "value": "string" } ], "originRoutingType": 0, "originRoutingTypeOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| distributionId | string | "string" | Returns the identifier for the distribution |
| originGroupId | string | "string" | Returns the user input name of origin group |
| origins | string | "string" | Returns all the origins |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| originRoutingType | integer($int32) | 0 | Returns the chosen routing type |
| originRoutingTypeOptions | array [object] | Returns an object of all the options of origin routing type | |
| id | integer($int32) | 0 | Returns the idetifier of origin groups entity |
| value | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found