Jump to

• Request
• Response

Import all Service Area Restrictions

post

ss/oc-cnpolicy-configuration/v1/policydata/pcfam/servicearearestrictions/import

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  Action

  Allowed Values: [ "ignore", "replace" ]

Body ()

body

Root Schema : ServiceAreaRestrictionIEDataReq

Type: object

Title: ServiceAreaRestrictionIEDataReq

Show Source

• date(optional): string
• exportData: array exportData
• key(optional): string
• sourceVersion(optional): string
• systemVersion(optional): string
• topic: string

{
    "type":"object",
    "required":[
        "exportData",
        "topic"
    ],
    "properties":{
        "date":{
            "type":"string"
        },
        "exportData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAreaRestriction"
            }
        },
        "key":{
            "type":"string"
        },
        "sourceVersion":{
            "type":"string"
        },
        "systemVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"ServiceAreaRestrictionIEDataReq"
}

Nested Schema : exportData

Type: array

Show Source

• Array of: object ServiceAreaRestriction
  Title: ServiceAreaRestriction

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

Nested Schema : ServiceAreaRestriction

Type: object

Title: ServiceAreaRestriction

Show Source

• areas(optional): array areas
• description(optional): string
• maxNumOfTAs(optional): number
• name: string
• restrictionType(optional): string
  Allowed Values: [ "ALLOWED_AREAS", "NOT_ALLOWED_AREAS" ]

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAreaRestrictionAreas"
            }
        },
        "description":{
            "type":"string"
        },
        "maxNumOfTAs":{
            "type":"number"
        },
        "name":{
            "type":"string"
        },
        "restrictionType":{
            "type":"string",
            "enum":[
                "ALLOWED_AREAS",
                "NOT_ALLOWED_AREAS"
            ]
        }
    },
    "title":"ServiceAreaRestriction"
}

Nested Schema : areas

Type: array

Show Source

• Array of: object ServiceAreaRestrictionAreas
  Title: ServiceAreaRestrictionAreas

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

Nested Schema : ServiceAreaRestrictionAreas

Type: object

Title: ServiceAreaRestrictionAreas

Show Source

• areaCodes(optional): string
• tacs(optional): array tacs

{
    "type":"object",
    "properties":{
        "areaCodes":{
            "type":"string"
        },
        "tacs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"ServiceAreaRestrictionAreas"
}

Nested Schema : tacs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/problem+json

200 Response

OK

Body ()

Root Schema : schema

Type: object

201 Response

Imported

Body ()

Root Schema : ServiceAreaRestrictionIEDataRes

Type: object

Title: ServiceAreaRestrictionIEDataRes

Show Source

• date(optional): string
• exportData: array exportData
• key(optional): string
• sourceVersion(optional): string
• topic: string

{
    "type":"object",
    "required":[
        "exportData",
        "topic"
    ],
    "properties":{
        "date":{
            "type":"string"
        },
        "exportData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAreaRestriction"
            }
        },
        "key":{
            "type":"string"
        },
        "sourceVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"ServiceAreaRestrictionIEDataRes"
}

Nested Schema : exportData

Type: array

Show Source

• Array of: object ServiceAreaRestriction
  Title: ServiceAreaRestriction

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

Nested Schema : ServiceAreaRestriction

Type: object

Title: ServiceAreaRestriction

Show Source

• areas(optional): array areas
• description(optional): string
• maxNumOfTAs(optional): number
• name: string
• restrictionType(optional): string
  Allowed Values: [ "ALLOWED_AREAS", "NOT_ALLOWED_AREAS" ]

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAreaRestrictionAreas"
            }
        },
        "description":{
            "type":"string"
        },
        "maxNumOfTAs":{
            "type":"number"
        },
        "name":{
            "type":"string"
        },
        "restrictionType":{
            "type":"string",
            "enum":[
                "ALLOWED_AREAS",
                "NOT_ALLOWED_AREAS"
            ]
        }
    },
    "title":"ServiceAreaRestriction"
}

Nested Schema : areas

Type: array

Show Source

• Array of: object ServiceAreaRestrictionAreas
  Title: ServiceAreaRestrictionAreas

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

Nested Schema : ServiceAreaRestrictionAreas

Type: object

Title: ServiceAreaRestrictionAreas

Show Source

• areaCodes(optional): string
• tacs(optional): array tacs

{
    "type":"object",
    "properties":{
        "areaCodes":{
            "type":"string"
        },
        "tacs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"ServiceAreaRestrictionAreas"
}

Nested Schema : tacs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

405 Response

Method Not Allowed

406 Response

Not Acceptable

408 Response

Request Timeout

409 Response

Conflict

412 Response

Precondition Failed

500 Response

Internal Server Error

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top