openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/COM_BSP_RESULT_BP:
    post:
      tags:
      - COM_BUPA_BSP_SEARCH
      operationId: /rfc/COM_BSP_RESULT_BP
      requestBody:
        content:
          application/json:
            schema:
              properties:
                IT_PARTNER_KEYS:
                  type: array
                  items:
                    type: object
                    properties:
                      PARTNER:
                        type: string
                        maxLength: 10
                        description: Business Partner Number
                      PARTNER_GUID:
                        type: string
                        format: byte
                        description: Business Partner GUID
                IV_LOCK:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Boolean Type, Do Not Use in Interfaces!
                IV_WITH_DEFAULT_CONTACTS:
                  type: string
                  default: X
                  maxLength: 1
                  description: Boolean Type, Do Not Use in Interfaces!
              required:
              - IT_PARTNER_KEYS
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ET_RESULT:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJECT_KEY:
                          type: string
                          maxLength: 100
                          description: Object Key
                        OBJECT_TYPE:
                          type: string
                          maxLength: 10
                          description: Object Type
                        PARTNER1:
                          type: string
                          maxLength: 10
                          description: Business Partner Number
                        COP_MAIN_OBJECT_KEY:
                          type: string
                          maxLength: 100
                          description: Object Key
                        COP_OBJECT_KEY:
                          type: string
                          maxLength: 100
                          description: Object Key
                        EMP_OBJECT_KEY:
                          type: string
                          maxLength: 100
                          description: Object Key
                        ADDRESS_GUID:
                          type: string
                          format: byte
                          description: GUID of a Business Partner Address
                        ADR_NOTES:
                          type: string
                          maxLength: 50
                          description: Address notes
                        COUNTRY_TEXT:
                          type: string
                          maxLength: 50
                          description: Country Description
                        REGION_TEXT:
                          type: string
                          maxLength: 20
                          description: Region (State, Province, County)
                        TEXT_LANGUAGE:
                          type: string
                          maxLength: 1
                          description: Language Key of Current Text Environment
                        LOGO:
                          type: string
                          maxLength: 132
                          description: URI, e.g. Homepage or ftp Address
                        FURTHER_ADDRESSES:
                          type: string
                          maxLength: 1
                          description: 'BSP: GIF for Further Addresses'
                        JUMP_TO_APPL:
                          type: string
                          maxLength: 20
                          description: Application Scenario
                        BP_NAME1:
                          type: string
                          maxLength: 40
                          description: Name 1 / Last Name (Search Help Field 1)
                        BP_NAME2:
                          type: string
                          maxLength: 40
                          description: Name 2 / First Name (Search Help Field 2)
                        NAME_CO:
                          type: string
                          maxLength: 40
                          description: c/o name
                        CITY1:
                          type: string
                          maxLength: 40
                          description: City
                        CITY2:
                          type: string
                          maxLength: 40
                          description: District
                        CITY_CODE:
                          type: string
                          maxLength: 12
                          description: City code for city/street file
                        CITYP_CODE:
                          type: string
                          maxLength: 8
                          description: District code for City and Street file
                        HOME_CITY:
                          type: string
                          maxLength: 40
                          description: City (different from postal city)
                        CITYH_CODE:
                          type: string
                          maxLength: 12
                          description: Different city for city/street file
                        CHCKSTATUS:
                          type: string
                          maxLength: 1
                          description: City file test status
                        REGIOGROUP:
                          type: string
                          maxLength: 8
                          description: Regional structure grouping
                        POST_CODE1:
                          type: string
                          maxLength: 10
                          description: City postal code
                        POST_CODE2:
                          type: string
                          maxLength: 10
                          description: PO Box postal code
                        POST_CODE3:
                          type: string
                          maxLength: 10
                          description: Company postal code (for large customers)
                        PCODE1_EXT:
                          type: string
                          maxLength: 10
                          description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code
                        PCODE2_EXT:
                          type: string
                          maxLength: 10
                          description: (Not Supported) PO Box Postal Code Extension
                        PCODE3_EXT:
                          type: string
                          maxLength: 10
                          description: (Not Supported) Major Customer Postal Code Extension
                        PO_BOX:
                          type: string
                          maxLength: 10
                          description: PO Box
                        DONT_USE_P:
                          type: string
                          maxLength: 4
                          description: PO Box Address Undeliverable Flag
                        PO_BOX_NUM:
                          type: string
                          maxLength: 1
                          description: 'Flag: PO Box without number'
                        PO_BOX_LOC:
                          type: string
                          maxLength: 40
                          description: PO Box city
                        CITY_CODE2:
                          type: string
                          maxLength: 12
                          description: City PO box code (City file)
                        PO_BOX_REG:
                          type: string
                          maxLength: 3
                          description: Region for PO Box (Country, State, Province, ...)
                        PO_BOX_CTY:
                          type: string
                          maxLength: 3
                          description: PO box country
                        POSTALAREA:
                          type: string
                          maxLength: 15
                          description: (Not Supported) Post Delivery District
                        TRANSPZONE:
                          type: string
                          maxLength: 10
                          description: Transportation zone to or from which the goods are delivered
                        STREET:
                          type: string
                          maxLength: 60
                          description: Street
                        DONT_USE_S:
                          type: string
                          maxLength: 4
                          description: Street Address Undeliverable Flag
                        STREETCODE:
                          type: string
                          maxLength: 12
                          description: Street Number for City/Street File
                        STREETABBR:
                          type: string
                          maxLength: 2
                          description: (Not Supported) Abbreviation of Street Name
                        HOUSE_NUM1:
                          type: string
                          maxLength: 10
                          description: House Number
                        HOUSE_NUM2:
                          type: string
                          maxLength: 10
                          description: House number supplement
                        HOUSE_NUM3:
                          type: string
                          maxLength: 10
                          description: (Not supported) House Number Range
                        STR_SUPPL1:
                          type: string
                          maxLength: 40
                          description: Street 2
                        STR_SUPPL2:
                          type: string
                          maxLength: 40
                          description: Street 3
                        STR_SUPPL3:
                          type: string
                          maxLength: 40
                          description: Street 4
                        LOCATION:
                          type: string
                          maxLength: 40
                          description: Street 5
                        BUILDING:
                          type: string
                          maxLength: 20
                          description: Building (Number or Code)
                        FLOOR:
                          type: string
                          maxLength: 10
                          description: Floor in building
                        ROOMNUMBER:
                          type: string
                          maxLength: 10
                          description: Room or Appartment Number
                        COUNTRY:
                          type: string
                          maxLength: 3
                          description: Country Key
                        LANGU:
                          type: string
                          maxLength: 1
                          description: Language Key
                        REGION:
                          type: string
                          maxLength: 3
                          description: Region (State, Province, County)
                        SORT1:
                          type: string
                          maxLength: 20
                          description: Search Term 1
                        SORT2:
                          type: string
                          maxLength: 20
                          description: Search Term 2
                        SORT_PHN:
                          type: string
                          maxLength: 20
                          description: (Not Supported) Phonetic Search Sort Field
                        ADDRORIGIN:
                          type: string
                          maxLength: 4
                          description: (Not Supported) Address Data Source (Key)
                        EXTENSION1:
                          type: string
                          maxLength: 40
                          description: Extension (only for data conversion) (e.g. data line)
                        EXTENSION2:
                          type: string
                          maxLength: 40
                          description: Extension (only for data conversion) (e.g. telebox)
                        TIME_ZONE:
                          type: string
                          maxLength: 6
                          description: Address time zone
                        TAXJURCODE:
                          type: string
                          maxLength: 15
                          description: Tax Jurisdiction
                        ADDRESS_ID:
                          type: string
                          maxLength: 10
                          description: (Not supported) Physical address ID
                        REMARK:
                          type: string
                          maxLength: 50
                          description: Address notes
                        LANGU_CREA:
                          type: string
                          maxLength: 1
                          description: Address record creation original language
                        COUNTRY_DESCRIPTION:
                          type: string
                          maxLength: 15
                          description: Country Name
                        REGION_DESCRIPTION:
                          type: string
                          maxLength: 20
                          description: Description
                        TRANSPZONE_DESCRIPTION:
                          type: string
                          maxLength: 20
                          description: Description
                        REGIOGROUP_DESCRIPTION:
                          type: string
                          maxLength: 50
                          description: Text Field
                        PO_BOX_CTY_DESCRIPTION:
                          type: string
                          maxLength: 15
                          description: Country Name
                        PO_BOX_REG_DESCRIPTION:
                          type: string
                          maxLength: 20
                          description: Description
                        CONSNO_TEL:
                          type: integer
                          format: int64
                          description: Sequence number
                        TEL1_NUMBR:
                          type: string
                          maxLength: 30
                          description: 'First telephone no.: dialling code+number'
                        TEL1_EXT:
                          type: string
                          maxLength: 10
                          description: 'First Telephone No.: Extension'
                        TELEPHONE:
                          type: string
                          maxLength: 30
                          description: 'Complete number: dialling code+number+extension'
                        CONSNO_FAX:
                          type: integer
                          format: int64
                          description: Sequence number
                        FAX:
                          type: string
                          maxLength: 30
                          description: 'Fax number: dialling code+number'
                        FAX_EXT:
                          type: string
                          maxLength: 10
                          description: 'Fax no.: Extension'
                        FAX_NO:
                          type: string
                          maxLength: 30
                          description: 'Complete number: dialling code+number+extension'
                        CONSNO_EMAIL:
                          type: integer
                          format: int64
                          description: Sequence number
                        EMAIL:
                          type: string
                          maxLength: 241
                          description: E-Mail Address
                        CONSNO_URL:
                          type: integer
                          format: int64
                          description: Sequence number
                        URL:
                          type: string
                          maxLength: 132
                          description: URL, for Example, Homepage or ftp Address
                        PARTNER_ROLE:
                          type: string
                          maxLength: 6
                          description: BP role
                        PARTNER_TYPE:
                          type: string
                          maxLength: 1
                          description: Business Partner Category
                        CON_NAME_FIRST:
                          type: string
                          maxLength: 25
                          description: Contact Person First Name
                        CON_NAME_LAST:
                          type: string
                          maxLength: 25
                          description: Contact Person Last Name
                        EMP_NAME_FIRST:
                          type: string
                          maxLength: 25
                          description: Employee's First Name
                        EMP_NAME_LAST:
                          type: string
                          maxLength: 25
                          description: Employee's Last Name
                        MY_ACCOUNTS:
                          type: string
                          maxLength: 1
                          description: My Business Partners
                        HITS:
                          type: integer
                          format: int64
                          description: Maximum Number of Hits
                        VALID_DATE:
                          type: string
                          format: date
                          description: Selection Date for Search Helps
                        IDTYPE:
                          type: string
                          maxLength: 6
                          description: Identification Type
                        IDTYPE_DESCRIPTION:
                          type: string
                          maxLength: 40
                          description: Identification Type
                        IDNUMBER:
                          type: string
                          maxLength: 60
                          description: Identification Number
                        REL_PARTNER1:
                          type: string
                          maxLength: 10
                          description: Business Partner Number
                        REL_PARTNER2:
                          type: string
                          maxLength: 10
                          description: Business Partner Number
                        RELTYP:
                          type: string
                          maxLength: 6
                          description: Business Partner Relationship Category
                        XRF:
                          type: string
                          maxLength: 1
                          description: Business partner role definition instead of BP relationship
                        RS_INDEX:
                          type: integer
                          format: int64
                          description: Business Partner Relationship Category
                        XDIRECTION:
                          type: string
                          maxLength: 1
                          description: One-Way Business Partner Relationship Category
                        RS_REL_TYP:
                          type: string
                          maxLength: 6
                          description: Business Partner Relationship Category
                        RS_PARTNER:
                          type: string
                          maxLength: 10
                          description: Partner ID of Relationship
                        RS_NAME1:
                          type: string
                          maxLength: 40
                          description: Name 1 / Last Name (Search Help Field 1)
                        RS_NAME2:
                          type: string
                          maxLength: 40
                          description: Name 2 / First Name (Search Help Field 2)
                        BP_EEW_DUMMY:
                          type: string
                          maxLength: 1
                          description: Dummy function in length 1
                        BP_DESCRIPTION:
                          type: string
                          maxLength: 100
                          description: Character 100
                        CRM_OBJECT_TYPE:
                          type: string
                          maxLength: 30
                          description: Contains Field Name for Field that Contains Object Type
                        CRM_NAVI_METHOD:
                          type: string
                          maxLength: 20
                          description: Method for Navigation
                        NAVI_OBJECT_KEY:
                          type: string
                          maxLength: 100
                          description: Object Key
                        SEARCHTERM1:
                          type: string
                          maxLength: 20
                          description: Search term 1 for business partner
                        SEARCHTERM2:
                          type: string
                          maxLength: 20
                          description: Search term 2 for business partner
                        PARTNERTYPE:
                          type: string
                          maxLength: 4
                          description: Business partner type
                        AUTHORIZATIONGROUP:
                          type: string
                          maxLength: 4
                          description: Authorization Group
                        PARTNERLANGUAGE:
                          type: string
                          maxLength: 1
                          description: 'Business partner: Language'
                        PARTNERLANGUAGEISO:
                          type: string
                          maxLength: 2
                          description: Language according to ISO 639
                        DATAORIGINTYPE:
                          type: string
                          maxLength: 4
                          description: Data origin types
                        CENTRALARCHIVINGFLAG:
                          type: string
                          maxLength: 1
                          description: Central archiving flag
                        CENTRALBLOCK:
                          type: string
                          maxLength: 1
                          description: Central Block for Business Partner
                        TITLE_KEY:
                          type: string
                          maxLength: 4
                          description: Form-of-Address Key
                        CONTACTALLOWANCE:
                          type: string
                          maxLength: 1
                          description: 'Business Partner: Contact Permission'
                        PARTNEREXTERNAL:
                          type: string
                          maxLength: 20
                          description: Business partner number in external system
                        TITLELETTER:
                          type: string
                          maxLength: 50
                          description: Salutation
                        NOTRELEASED:
                          type: string
                          maxLength: 1
                          description: 'Indicator: Not Released'
                        COMM_TYPE:
                          type: string
                          maxLength: 3
                          description: Communication Method (Key) (Business Address Services)
                        PRINT_MODE:
                          type: string
                          maxLength: 1
                          description: Business Partner Print Format
                        FIRSTNAME:
                          type: string
                          maxLength: 40
                          description: First name of business partner (person)
                        LASTNAME:
                          type: string
                          maxLength: 40
                          description: Last name of business partner (person)
                        BIRTHNAME:
                          type: string
                          maxLength: 40
                          description: Name at birth of business partner
                        MIDDLENAME:
                          type: string
                          maxLength: 40
                          description: Middle name or second forename of a person
                        SECONDNAME:
                          type: string
                          maxLength: 40
                          description: Other Last Name of a Person
                        TITLE_ACA1:
                          type: string
                          maxLength: 4
                          description: 'Academic Title: Key'
                        TITLE_ACA2:
                          type: string
                          maxLength: 4
                          description: Second academic title (key)
                        TITLE_SPPL:
                          type: string
                          maxLength: 4
                          description: Name supplement, e.g. noble title (key)
                        PREFIX1:
                          type: string
                          maxLength: 4
                          description: Name Prefix (Key)
                        PREFIX2:
                          type: string
                          maxLength: 4
                          description: 2nd name prefix (key)
                        NICKNAME:
                          type: string
                          maxLength: 40
                          description: Nickname of Business Partner (Person)
                        INITIALS:
                          type: string
                          maxLength: 10
                          description: '"Middle Initial" or personal initials'
                        NAMEFORMAT:
                          type: string
                          maxLength: 2
                          description: Name format
                        NAMCOUNTRY:
                          type: string
                          maxLength: 3
                          description: Country for name format rule
                        NAMCOUNTRYISO:
                          type: string
                          maxLength: 2
                          description: Country ISO code
                        SEX:
                          type: string
                          maxLength: 1
                          description: Sex of business partner (person)
                        BIRTHPLACE:
                          type: string
                          maxLength: 40
                          description: Birthplace of business partner
                        BIRTHDATE:
                          type: string
                          format: date
                          description: Date of birth of business partner
                        DEATHDATE:
                          type: string
                          format: date
                          description: Date of death of business partner
                        MARITALSTATUS:
                          type: string
                          maxLength: 1
                          description: Marital status of business partner
                        CORRESPONDLANGUAGE:
                          type: string
                          maxLength: 1
                          description: 'Business Partner: Correspondence Language'
                        CORRESPONDLANGUAGEISO:
                          type: string
                          maxLength: 2
                          description: Language according to ISO 639
                        FULLNAME:
                          type: string
                          maxLength: 80
                          description: Full Name
                        EMPLOYER:
                          type: string
                          maxLength: 35
                          description: Employer of business partner
                        OCCUPATION:
                          type: string
                          maxLength: 4
                          description: Occupation/group
                        NATIONALITY:
                          type: string
                          maxLength: 3
                          description: Nationality
                        NATIONALITYISO:
                          type: string
                          maxLength: 2
                          description: Country ISO code
                        COUNTRYORIGIN:
                          type: string
                          maxLength: 3
                          description: 'Ctry of origin: non-res.companies'
                        NAME1:
                          type: string
                          maxLength: 40
                          description: Name 1 of organization
                        NAME2:
                          type: string
                          maxLength: 40
                          description: Name 2 of organization
                        NAME3:
                          type: string
                          maxLength: 40
                          description: Name 3 of organization
                        NAME4:
                          type: string
                          maxLength: 40
                          description: Name 4 of organization
                        LEGALFORM:
                          type: string
                          maxLength: 2
                          description: 'BP: Legal form of organization'
                        INDUSTRYSECTOR:
                          type: string
                          maxLength: 10
                          description: Industry sector
                        FOUNDATIONDATE:
                          type: string
                          format: date
                          description: Date organization founded
                        LIQUIDATIONDATE:
                          type: string
                          format: date
                          description: Liquidation date of organization
                        LOC_NO_1:
                          type: integer
                          format: int64
                          description: International location number  (part 1)
                        LOC_NO_2:
                          type: integer
                          format: int64
                          description: International location number (Part 2)
                        CHK_DIGIT:
                          type: integer
                          format: int64
                          description: Check digit for the international location number
                        LEGALORG:
                          type: string
                          maxLength: 2
                          description: Legal Entity of Organization
                        NAMEGROUP1:
                          type: string
                          maxLength: 40
                          description: Name 1 (group)
                        NAMEGROUP2:
                          type: string
                          maxLength: 40
                          description: Name 2 (group)
                        GROUPTYPE:
                          type: string
                          maxLength: 4
                          description: Group type
                        PARTNER1_GUID:
                          type: string
                          maxLength: 32
                          description: GUID of a Business Partner in CHAR 32 Format for BAPIs
                        NAME1_LONG:
                          type: string
                          maxLength: 50
                          description: Short name of business partner
                        PARTNER2:
                          type: string
                          maxLength: 10
                          description: Contact Person ID
                        PARTNER2_GUID:
                          type: string
                          maxLength: 32
                          description: GUID of a Business Partner in CHAR 32 Format for BAPIs
                        NAME2_LONG:
                          type: string
                          maxLength: 120
                          description: Short Description of Default Contact Person
                        CONT_TELEPHONE:
                          type: string
                          maxLength: 30
                          description: Contact Person Telephone
                        PARTNER_GROUP:
                          type: string
                          maxLength: 4
                          description: Business Partner Grouping
                        ADDRESS_NUMBER:
                          type: string
                          maxLength: 10
                          description: Address number
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
