Jump to

• Request
• Response
• Examples

Delete Server Property

delete

/essbase/rest/v1/properties/{propertyName}

Deletes a Provider Services configuration property from the Essbase Server.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• propertyName: string

  Property name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Successful operation.

Body ()

Root Schema : PropertyEntry

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

204 Response

OK

Property is deleted successfully. Returns the property details and the links to get/edit the property.

Body ()

Root Schema : PropertyEntry

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to delete the property. The JSON for the property may be incorrect, or the specified property may have already been deleted.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to remove a configured Provider Services property from the Essbase Server.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X DELETE "https://myserver.example.com:9001/essbase/rest/v1/properties/essbase.jobs.maxCount?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Back to Top