Skip to content

Application Configurations

Get Application Configurations

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/application-configurations

Description:
This endpoint Gets all ApplicationConfigurations.

Success Response:

Response Example: 

[
    {
        "key": "PointrCloudDashboardUrl",
        "Value": "https://dashboard.pointr.cloud",
        "valueType": "String"
    },
    {
        "key": "MapScaleRestApiBaseUrl",
        "Value": "https://mapscale-api.pointr.cloud",
        "valueType": "String"
    }
]


* You can access the possible response codes you may encounter here.

Get Application Configuration

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/application-configurations/{key}

Description:
This endpoint Gets the ApplicationConfiguration for a given key.

Success Response:

Response Example: 

{
    "key": "MapScaleRestApiBaseUrl",
    "Value": "https://mapscale-api.pointr.cloud",
    "valueType": "String"
}


* You can access the possible response codes you may encounter here.

Update Application Configurations

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/application-configurations

Description:

It deletes all existing ApplicationConfigurations, then inserts the new data provided in the request payload.

Validations
  • Key is required.
  • Value is required and length can not exceed 5000 characters.
  • ValueType is required.
  • ValueType must be one of "Float", "Double", "Integer", "Boolean", "String".

Request:

[
    {
        "key": "PointrCloudDashboardUrl",
        "Value": "https://dashboard2.pointr.cloud",
        "valueType": "String"
    },
    {
        "key": "MapScaleRestApiBaseUrl",
        "Value": "https://mapscale-api2.pointr.cloud",
        "valueType": "String"
    }
]

Success Response: 

{
  "message": "Application configurations are updated successfully."
}


* You can access the possible response codes you may encounter here.

Update Application Configuration

Endpoint:

PUT api/v9/content/draft/clients/{clientIdentifier}/application-configurations/{key}

Description:

Updates the configuration given as "key".

Validations
  • Key is required.
  • Value is required and length can not exceed 5000 characters.
  • ValueType is required.
  • ValueType must be one of "Float", "Double", "Integer", "Boolean", "String".

Request:

{
    "Value": "https://dashboard2.pointr.cloud",
    "valueType": "String"
}

Success Response: 

{
  "message": "Application configuration is updated successfully."
}


* You can access the possible response codes you may encounter here.

Delete Application Configuration

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/application-configurations/{key}

Description:
This endpoint is used to delete ApplicationConfigurations for a specific key with given clientIdentifier.

Success Response: 

{
  "message": "Application configuration deleted successfully."
}


* You can access the possible response codes you may encounter here.