Uppsala University OrganizedViolenceCY API

The OrganizedViolenceCY API from Uppsala University — 1 operation(s) for organizedviolencecy.

OpenAPI Specification

uppsala-organizedviolencecy-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: UCDP - The Public BattleDeaths OrganizedViolenceCY API
  description: 'Uppsala Conflict Data Program (UCDP) RESTful HTTP API returning JSON for UCDP conflict datasets: georeferenced events, UCDP/PRIO armed conflict, dyadic, non-state, one-sided violence, battle-related deaths, and organized violence country-year. Access requires a free token supplied in the x-ucdp-access-token header (quota 5,000 requests/day).'
  version: '1.0'
  contact:
    name: Uppsala Conflict Data Program
    url: https://ucdp.uu.se/apidocs/
servers:
- url: https://ucdpapi.pcr.uu.se
  description: UCDP Public API
security:
- ApiToken: []
tags:
- name: OrganizedViolenceCY
paths:
  /api/organizedviolencecy/{version}:
    get:
      tags:
      - OrganizedViolenceCY
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: pagesize
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      - name: Country
        in: query
        schema:
          type: string
      - name: Country_Id
        in: query
        schema:
          type: string
      - name: Year
        in: query
        schema:
          type: string
      - name: Region
        in: query
        schema:
          type: string
      - name: Govt_name
        in: query
        schema:
          type: string
      - name: Sb_exist
        in: query
        schema:
          type: string
      - name: Sb_intrastate_exist
        in: query
        schema:
          type: string
      - name: Sb_interstate_exist
        in: query
        schema:
          type: string
      - name: Ns_exist
        in: query
        schema:
          type: string
      - name: Os_exist
        in: query
        schema:
          type: string
      - name: Key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrganizedViolenceCYDbAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizedViolenceCYDbAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/OrganizedViolenceCYDbAPIResponse'
components:
  schemas:
    OrganizedViolenceCYDbAPIResponse:
      type: object
      properties:
        TotalCount:
          type: integer
          format: int32
          nullable: true
        TotalPages:
          type: integer
          format: int32
          nullable: true
        PreviousPageUrl:
          type: string
          nullable: true
        NextPageUrl:
          type: string
          nullable: true
        Result:
          type: array
          items:
            $ref: '#/components/schemas/OrganizedViolenceCYDb'
          nullable: true
      additionalProperties: false
    OrganizedViolenceCYDb:
      type: object
      properties:
        country:
          type: string
          nullable: true
        country_id:
          type: integer
          format: int32
          nullable: true
        year:
          type: integer
          format: int32
          nullable: true
        region:
          type: string
          nullable: true
        govt_name:
          type: string
          nullable: true
        sb_exist:
          type: integer
          format: int32
          nullable: true
        sb_dyad_count:
          type: integer
          format: int32
          nullable: true
        sb_dyad_ids:
          type: string
          nullable: true
        sb_dyad_names:
          type: string
          nullable: true
        sb_deaths_parties:
          type: integer
          format: int32
          nullable: true
        sb_deaths_civilians:
          type: integer
          format: int32
          nullable: true
        sb_deaths_unknown:
          type: integer
          format: int32
          nullable: true
        sb_total_deaths_best:
          type: integer
          format: int32
          nullable: true
        sb_total_deaths_high:
          type: integer
          format: int32
          nullable: true
        sb_total_deaths_low:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_exist:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_dyad_count:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_dyad_ids:
          type: string
          nullable: true
        sb_intrastate_dyad_names:
          type: string
          nullable: true
        sb_intrastate_govt_inv_incomp:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_parties:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_civilians:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_unknown:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_best:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_high:
          type: integer
          format: int32
          nullable: true
        sb_intrastate_deaths_low:
          type: integer
          format: int32
          nullable: true
        sb_interstate_exist:
          type: integer
          format: int32
          nullable: true
        sb_interstate_dyad_count:
          type: integer
          format: int32
          nullable: true
        sb_interstate_dyad_ids:
          type: string
          nullable: true
        sb_interstate_dyad_names:
          type: string
          nullable: true
        sb_interstate_govt_inv_incomp:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_parties:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_civilians:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_unknown:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_best:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_high:
          type: integer
          format: int32
          nullable: true
        sb_interstate_deaths_low:
          type: integer
          format: int32
          nullable: true
        ns_exist:
          type: integer
          format: int32
          nullable: true
        ns_dyad_count:
          type: integer
          format: int32
          nullable: true
        ns_dyad_ids:
          type: string
          nullable: true
        ns_dyad_names:
          type: string
          nullable: true
        ns_deaths_parties:
          type: integer
          format: int32
          nullable: true
        ns_deaths_civilians:
          type: integer
          format: int32
          nullable: true
        ns_deaths_unknown:
          type: integer
          format: int32
          nullable: true
        ns_total_deaths_best:
          type: integer
          format: int32
          nullable: true
        ns_total_deaths_high:
          type: integer
          format: int32
          nullable: true
        ns_total_deaths_low:
          type: integer
          format: int32
          nullable: true
        os_exist:
          type: integer
          format: int32
          nullable: true
        os_dyad_count:
          type: integer
          format: int32
          nullable: true
        os_dyad_ids:
          type: string
          nullable: true
        os_dyad_names:
          type: string
          nullable: true
        os_govt_inv:
          type: integer
          format: int32
          nullable: true
        os_govt_killings_best:
          type: integer
          format: int32
          nullable: true
        os_govt_killings_high:
          type: integer
          format: int32
          nullable: true
        os_govt_killings_low:
          type: integer
          format: int32
          nullable: true
        os_any_govt_inv:
          type: integer
          format: int32
          nullable: true
        os_any_govt_killings_best:
          type: integer
          format: int32
          nullable: true
        os_any_govt_killings_high:
          type: integer
          format: int32
          nullable: true
        os_any_govt_killings_low:
          type: integer
          format: int32
          nullable: true
        os_nsgroup_inv:
          type: integer
          format: int32
          nullable: true
        os_nsgroup_killings_best:
          type: integer
          format: int32
          nullable: true
        os_nsgroup_killings_high:
          type: integer
          format: int32
          nullable: true
        os_nsgroup_killings_low:
          type: integer
          format: int32
          nullable: true
        os_killings_unknown:
          type: integer
          format: int32
          nullable: true
        os_total_deaths_best:
          type: integer
          format: int32
          nullable: true
        os_total_deaths_high:
          type: integer
          format: int32
          nullable: true
        os_total_deaths_low:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_parties_in_orgvio:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_civilians_in_orgvio:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_unknown_in_orgvio:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_in_orgvio_best:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_in_orgvio_high:
          type: integer
          format: int32
          nullable: true
        cumulative_total_deaths_in_orgvio_low:
          type: integer
          format: int32
          nullable: true
        Version:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    ApiToken:
      type: apiKey
      description: UCDP API token sent in x-ucdp-access-token header
      name: x-ucdp-access-token
      in: header