Jump to

• Request
• Response
• Examples

Gets the policy

get

/oaa-policy/policy/v1/{policygid}

Request

Path Parameters

• policygid(required): string
  Identifier of the policy.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

Policy information

Body ()

Root Schema : PolicyResponse

Type: object

Show Source

• message: string
  Message related to the status of the request
• policy: object schema
  Policy object for creating, modifying and fetching policy.
• policygid: string
  Identifier of the policy.
• status: string
  Status of the request

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy."
        },
        "policy":{
            "$ref":"#/components/schemas/Policy"
        }
    }
}

Nested Schema : schema

Type: object

Policy object for creating, modifying and fetching policy.

Show Source

• agentgid(required): string
  Identifier of the agent to which the policy belongs
• assuranceLevelId(required): string
  Identifier of the assurance level which is associated with the policy
• description(required): string
  Policy description.
• name(required): string
  Policy Name.
• policygid: string
  Identifier of the policy
• scoringEngine: string
  Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)
• status(required): string
  Status of the policy. It can be one of the following values. Active, Disabled or Deleted.
• weight: integer
  Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level.

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

401 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : PolicyResponse

Type: object

Show Source

• message: string
  Message related to the status of the request
• policy: object schema
  Policy object for creating, modifying and fetching policy.
• policygid: string
  Identifier of the policy.
• status: string
  Status of the request

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy."
        },
        "policy":{
            "$ref":"#/components/schemas/Policy"
        }
    }
}

Nested Schema : schema

Type: object

Policy object for creating, modifying and fetching policy.

Show Source

• agentgid(required): string
  Identifier of the agent to which the policy belongs
• assuranceLevelId(required): string
  Identifier of the assurance level which is associated with the policy
• description(required): string
  Policy description.
• name(required): string
  Policy Name.
• policygid: string
  Identifier of the policy
• scoringEngine: string
  Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)
• status(required): string
  Status of the policy. It can be one of the following values. Active, Disabled or Deleted.
• weight: integer
  Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level.

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top

Examples

The following example shows a sample request and response for retrieving all policies.

cURL Command to Retrieve all Policies in JSON Format

curl --location --request GET '<PolicyUrl>/oaa-policy/policy/v1/141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in JSON Format

{
    "status": "200",
    "message": "Policy information.",
    "policygid": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171",
    "policy": {
        "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
        "assuranceLevelId": "AssuranceLevel1",
        "name": "Policy1",
        "description": "Policy for AssuranceLevel1",
        "status": "ACTIVE",
        "scoringEngine": "Average",
        "weight": 100,
        "policygid": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171"
    }
}

cURL Command to Retrieve all Policies in XML Format

curl --location --request GET '<PolicyUrl>/oaa-policy/policy/v1/141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PolicyResponse>
     <status>200</status>
     <message>Policy information.</message>
     <policygid>141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171</policygid>
     <policy>
         <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
         <assuranceLevelId>AssuranceLevel1</assuranceLevelId>
         <name>Policy1</name>
         <description>Policy for AssuranceLevel1</description>
         <status>ACTIVE</status>
         <scoringEngine>Average</scoringEngine>
         <weight>100</weight>
         <policygid>141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171</policygid>
     </policy>
 </PolicyResponse>

Back to Top