openapi: 3.0.0 info: title: SAP API version: 1.0.0 servers: - url: http://localhost:8080 paths: /rfc/ALINK_KPRO_DOC_QUERY_RFC: post: tags: - ALINK_KPRO_QUERY operationId: /rfc/ALINK_KPRO_DOC_QUERY_RFC requestBody: content: application/json: schema: properties: IM_DOCUSPACE: type: object properties: NAME: type: string maxLength: 10 description: Document Area RFC_DEST: type: string maxLength: 32 description: Logical Destination (Specified in Function Call) DESCR: type: string maxLength: 64 description: Short Description IDX_CAT: type: string maxLength: 32 description: Index category identification IDX_ACT: type: string maxLength: 1 description: 'SAP ArchiveLink: IMS Storage Active enumValues: X=Active,""=Inactive' enum: - X - '' SEARCH_CLS: type: string maxLength: 30 description: 'Document Finder: Query Class' VIEW_CLS: type: string maxLength: 30 description: 'Document Finder: Display Class' FTS_ACTIVE: type: string maxLength: 1 description: 'Document Finder: Full Text Search Active enumValues: X=Active,""=Inactive' enum: - X - '' MAX_HITS: type: integer format: int64 description: Maximum Number of Hits X_FEDAREA: type: string maxLength: 1 description: 'SAP ArchiveLink: Status (X = active, otherwise inactive) enumValues: X=Active,""=Inactive' enum: - X - '' DS_ACTIVE: type: string maxLength: 1 description: 'Document Area Active enumValues: X=Active,""=Inactive' enum: - X - '' IM_USER: type: string default: SY-UNAME maxLength: 12 description: User Name EX_RESULTATTR_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' DESCR: type: string maxLength: 64 description: Short Description MULTATRCNT: type: integer format: int64 description: Multi-document Attribute Counter TYPE: type: string maxLength: 1 description: Document Attribute Type VALUE1: type: string maxLength: 64 description: Value of a Document Attribute VALUE2: type: string maxLength: 64 description: Value of a Document Attribute OPERATOR: type: string maxLength: 5 description: Operator DOCREFER: type: integer format: int64 description: Reference of a Document Attribute to a Document EX_RESULTDOC_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area X_FOLDER: type: string maxLength: 1 description: 'SAP ArchiveLink: Status (X = active, otherwise inactive) enumValues: X=Active,""=Inactive' enum: - X - '' DOCID: type: string maxLength: 100 description: 'ArchiveLink: Kpro : Doc ID for Document Finder' CONTREP_ID: type: string maxLength: 30 description: Storage Repository for Physical Objects MIME_TYPE: type: string maxLength: 128 description: HTML content type DESCR: type: string maxLength: 128 description: 'SAP ArchiveLink: KPRO: Hit Description' AR_DATE: type: string format: date description: 'SAP ArchiveLink: Storage date' RANKV: type: integer format: int64 description: Rank in the hit list LANGU: type: string maxLength: 2 description: Language According to ISO 639 (2 Character) COUNTER: type: integer format: int64 description: Document counter NODE: type: integer format: int64 description: Document counter IM_LANGUAGE_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area LAISO: type: string maxLength: 2 description: Language According to ISO 639 (2 Character) LANGU: type: string maxLength: 1 description: Language Key IM_QUERYPARAM_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 25 description: Attribute Name VALUE1: type: string maxLength: 25 description: Attribute Value VALUE2: type: string maxLength: 25 description: Attribute Value OPERATOR: type: string maxLength: 5 description: Operator IM_QUERY_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area SECOUNT: type: integer format: int64 description: Search Term Counter LOCATION: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' VALUE1: type: string maxLength: 255 description: Value of an attribute, term or operator in the search VALUE2: type: string maxLength: 255 description: Value of an attribute, term or operator in the search OPERATOR: type: string maxLength: 5 description: Operator ROWTYPE: type: string maxLength: 2 description: Row Type of a Search Request IM_RANGE_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area PROP_NAME: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' SIGN: type: string maxLength: 1 description: 'Include-exclude attribute in search query enumValues: E=Exclusive no.,I=Inclusive no.' enum: - E - I OPERATOR: type: string maxLength: 2 description: 'Relational operator in search query enumValues: NE=Not equal to,CP=Contains template ...,LT=Less than,GT=Greater than,LE=Less than or equal to,EQ=Equal to,BT=Between ... and ...,NP=Contains no template ...,GE=Greater than or equal to,NB=Not between ... and ...' enum: - NE - CP - LT - GT - LE - EQ - BT - NP - GE - NB LOW: type: string maxLength: 64 description: Lower interval limit for search query HIGH: type: string maxLength: 64 description: Upper interval limit for search query IM_TERMATTR_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 25 description: Attribute Name VALUE1: type: string maxLength: 25 description: Attribute Value VALUE2: type: string maxLength: 25 description: Attribute Value OPERATOR: type: string maxLength: 5 description: Operator QTREFER: type: integer format: int64 description: Assignment of term attribute to search term required: - IM_DOCUSPACE responses: '200': description: OK content: application/json: schema: properties: EX_NUMBER_OF_HITS: type: integer format: int64 EX_RESULTATTR_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' DESCR: type: string maxLength: 64 description: Short Description MULTATRCNT: type: integer format: int64 description: Multi-document Attribute Counter TYPE: type: string maxLength: 1 description: Document Attribute Type VALUE1: type: string maxLength: 64 description: Value of a Document Attribute VALUE2: type: string maxLength: 64 description: Value of a Document Attribute OPERATOR: type: string maxLength: 5 description: Operator DOCREFER: type: integer format: int64 description: Reference of a Document Attribute to a Document EX_RESULTDOC_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area X_FOLDER: type: string maxLength: 1 description: 'SAP ArchiveLink: Status (X = active, otherwise inactive) enumValues: X=Active,""=Inactive' enum: - X - '' DOCID: type: string maxLength: 100 description: 'ArchiveLink: Kpro : Doc ID for Document Finder' CONTREP_ID: type: string maxLength: 30 description: Storage Repository for Physical Objects MIME_TYPE: type: string maxLength: 128 description: HTML content type DESCR: type: string maxLength: 128 description: 'SAP ArchiveLink: KPRO: Hit Description' AR_DATE: type: string format: date description: 'SAP ArchiveLink: Storage date' RANKV: type: integer format: int64 description: Rank in the hit list LANGU: type: string maxLength: 2 description: Language According to ISO 639 (2 Character) COUNTER: type: integer format: int64 description: Document counter NODE: type: integer format: int64 description: Document counter IM_LANGUAGE_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area LAISO: type: string maxLength: 2 description: Language According to ISO 639 (2 Character) LANGU: type: string maxLength: 1 description: Language Key IM_QUERYPARAM_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 25 description: Attribute Name VALUE1: type: string maxLength: 25 description: Attribute Value VALUE2: type: string maxLength: 25 description: Attribute Value OPERATOR: type: string maxLength: 5 description: Operator IM_QUERY_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area SECOUNT: type: integer format: int64 description: Search Term Counter LOCATION: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' VALUE1: type: string maxLength: 255 description: Value of an attribute, term or operator in the search VALUE2: type: string maxLength: 255 description: Value of an attribute, term or operator in the search OPERATOR: type: string maxLength: 5 description: Operator ROWTYPE: type: string maxLength: 2 description: Row Type of a Search Request IM_RANGE_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area PROP_NAME: type: string maxLength: 64 description: 'SAP ArchiveLink: Name of Document Attribute' SIGN: type: string maxLength: 1 description: 'Include-exclude attribute in search query enumValues: E=Exclusive no.,I=Inclusive no.' enum: - E - I OPERATOR: type: string maxLength: 2 description: 'Relational operator in search query enumValues: NE=Not equal to,CP=Contains template ...,LT=Less than,GT=Greater than,LE=Less than or equal to,EQ=Equal to,BT=Between ... and ...,NP=Contains no template ...,GE=Greater than or equal to,NB=Not between ... and ...' enum: - NE - CP - LT - GT - LE - EQ - BT - NP - GE - NB LOW: type: string maxLength: 64 description: Lower interval limit for search query HIGH: type: string maxLength: 64 description: Upper interval limit for search query IM_TERMATTR_TAB: type: array items: type: object properties: DOCSP: type: string maxLength: 10 description: Document Area NAME: type: string maxLength: 25 description: Attribute Name VALUE1: type: string maxLength: 25 description: Attribute Value VALUE2: type: string maxLength: 25 description: Attribute Value OPERATOR: type: string maxLength: 5 description: Operator QTREFER: type: integer format: int64 description: Assignment of term attribute to search term '400': description: Bad request. 5XX: description: Unexpected error.