openapi: 3.0.0 info: title: SAP API version: 1.0.0 servers: - url: http://localhost:8080 paths: /rfc/APPOINTMENT_GET: post: tags: - SSC0 summary: Read appointments operationId: /rfc/APPOINTMENT_GET requestBody: content: application/json: schema: properties: DATE_FROM: type: string format: date DATE_TO: type: string format: date APPOINTMENTS: type: array items: type: object properties: OWNER: type: string maxLength: 12 description: Owner of an Appointment Calendar APPT_ID: type: string maxLength: 25 description: General appointment ID GENAPPT_ID: type: string maxLength: 25 description: Generated appointment ID LOGSYS: type: string maxLength: 10 description: Logical system OBJTYPE: type: string maxLength: 10 description: Object Type OBJKEY: type: string maxLength: 70 description: Object key APPT_TYPE: type: string maxLength: 12 description: Technical Date Type Name ROOM: type: string maxLength: 12 description: Appointment room CUST_NO: type: string maxLength: 10 description: Customer number TXT_SHORT: type: string maxLength: 120 description: Short text TXT_PUB_ID: type: string maxLength: 25 description: Internal Identification of Rules of Periodic Appointments TXT_PRIVAT: type: string maxLength: 1 description: Private text exists flag CLASS_ID: type: string maxLength: 1 description: 'Visibility for Other Users enumValues: 2=private,1=public,3=secret' enum: - '2' - '1' - '3' BD_ACCS_ID: type: string maxLength: 1 description: 'Changeability of Appointment Description, Obsolete enumValues: 2=Can be changed by the organizer,1=Can be changed by all participants' enum: - '2' - '1' MAINT_ID: type: string maxLength: 1 description: Obsolete STATUS: type: string maxLength: 1 description: 'Appointment Management: Status of an Appointment enumValues: 1=Taking Place,3=Canceled,2=Planned' enum: - '1' - '3' - '2' PART_STAT: type: string maxLength: 1 description: 'Appt. Management: Reply Status of Group Appt. Participants enumValues: 3=Declined,9=No Reply,2=With Reservation,1=Accepted' enum: - '3' - '9' - '2' - '1' PART_ROLE: type: string maxLength: 1 description: 'Appt. Management: Attendance of Group Appt. Participant enumValues: 3=Optional Participant,2=Required Participant,9=No Participants' enum: - '3' - '2' - '9' PART_SNDML: type: string maxLength: 1 description: 'Inform Participants by E-Mail enumValues: ""=Do Not Send Mail,X=Send Mail' enum: - '' - X INFO_ID: type: string maxLength: 1 description: 'Indicator: Substitution Active enumValues: ""=Not Selected,X=Selected' enum: - '' - X ADMIN_ID: type: string maxLength: 40 description: Documentation in the Administration Part PRIORITY: type: integer format: int64 description: Appointment priority ENTRY_BY: type: string maxLength: 12 description: Creator CHANGE_BY: type: string maxLength: 12 description: Last changed by DOMINANT: type: string maxLength: 1 description: 'All-Day Event enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' EXIT_INFO: type: string maxLength: 60 description: User exit information DATE_FROM: type: string format: date description: Start Date TIME_FROM: type: string maxLength: 6 description: From Time ZONE_FROM: type: string maxLength: 6 description: 'Appointment calendar: Time zone of start of appointment' TST_FROM: type: integer format: int64 description: Time Stamp (UTC) of Start Time of Appointment DATE_TO: type: string format: date description: End Date TIME_TO: type: string maxLength: 6 description: To Time ZONE_TO: type: string maxLength: 6 description: 'Appointment calendar: Time zone of end of appointment' TST_TO: type: integer format: int64 description: Time stamp of end of appointment ENTRY_DAT: type: string format: date description: Creation date ENTRY_TIM: type: string maxLength: 6 description: Creation Time ENTRY_TST: type: integer format: int64 description: Time stamp of creation CHANGE_DAT: type: string format: date description: Changed On CHANGE_TIM: type: string maxLength: 6 description: Last changed at CHANGE_TST: type: integer format: int64 description: Time Stamp of Change Time SHOW_LOCAL: type: string maxLength: 1 description: 'Display appointment in the local time of the appointment enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' BUSY: type: string maxLength: 1 description: 'Status for Search for Times Without Appointments enumValues: 0=Available,2=Reserved' enum: - '0' - '2' SEQUENCE: type: integer format: int32 description: Number of Times an Appointment Has Been Updated APPL_GUID: type: string format: byte description: GUID (Hex) Specified by the Application APPT_GUID: type: string format: byte description: GUID of Appointment REQU_TEXT: type: string maxLength: 1 description: 'Appointment title required entry flag enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' REQU_ROOM: type: string maxLength: 1 description: 'A Room Must Be Specified for Appointments of this Type enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CREATEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CREATEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CHANGEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CHANGEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_DELETEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_DELETEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' COLOR: type: integer format: int32 description: 'Appointment Management: Color of Appts. of Certain Types enumValues: 7=Red,8=Violet,1=Background,4=Yellow,5=Blue-green,3=Light gray,2=Gray-blue,6=Green' enum: - '7' - '8' - '1' - '4' - '5' - '3' - '2' - '6' ICON: type: string maxLength: 4 description: 'Appointment Management: Icon for Appts of Certain Types' FUNCMODULE: type: string maxLength: 30 description: Name of function module APPT_GROUP: type: string maxLength: 12 description: Technical Name of Appointment Type Group TXT_LONG: type: string maxLength: 40 description: Description CONTACT: type: string maxLength: 10 description: Obsolete MAINT_INDI: type: string maxLength: 1 description: Maintenance identifier MARK_INDI: type: string maxLength: 1 description: Maintenance identifier OWNER_OR_DISTR_LIST: type: array items: type: object properties: OWNER: type: string maxLength: 12 description: Owner of an Appointment Calendar DISTR_INDI: type: string maxLength: 1 description: 'Address Type enumValues: A=External address,O=SAPoffice user,""=Address name,C=Shared distribution list,B=SAP user,P=Private distribution list' enum: - A - O - '' - C - B - P LOGSYS: type: string maxLength: 10 description: Logical system OBJTYPE: type: string maxLength: 10 description: Object Type OBJKEY: type: string maxLength: 70 description: Object key STATUS: type: string maxLength: 1 description: 'Appt. Management: Reply Status of Group Appt. Participants enumValues: 3=Declined,9=No Reply,2=With Reservation,1=Accepted' enum: - '3' - '9' - '2' - '1' ROLE: type: string maxLength: 1 description: 'Appt. Management: Attendance of Group Appt. Participant enumValues: 3=Optional Participant,2=Required Participant,9=No Participants' enum: - '3' - '2' - '9' SEND_MAIL: type: string maxLength: 1 description: 'Inform Participants by E-Mail enumValues: ""=Do Not Send Mail,X=Send Mail' enum: - '' - X EXTERN_FB: type: string maxLength: 1 description: 'Get External Free/Busy Dates (Using The Address Management) enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' ADDRNUMBER: type: string maxLength: 10 description: Address number PERSNUMBER: type: string maxLength: 10 description: Person number COMM_MODE: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) CONSNUMBER: type: integer format: int64 description: Sequence number OWNER_NAME: type: string maxLength: 120 description: User name (external format) required: - DATE_FROM - DATE_TO responses: '200': description: OK content: application/json: schema: properties: APPOINTMENTS: type: array items: type: object properties: OWNER: type: string maxLength: 12 description: Owner of an Appointment Calendar APPT_ID: type: string maxLength: 25 description: General appointment ID GENAPPT_ID: type: string maxLength: 25 description: Generated appointment ID LOGSYS: type: string maxLength: 10 description: Logical system OBJTYPE: type: string maxLength: 10 description: Object Type OBJKEY: type: string maxLength: 70 description: Object key APPT_TYPE: type: string maxLength: 12 description: Technical Date Type Name ROOM: type: string maxLength: 12 description: Appointment room CUST_NO: type: string maxLength: 10 description: Customer number TXT_SHORT: type: string maxLength: 120 description: Short text TXT_PUB_ID: type: string maxLength: 25 description: Internal Identification of Rules of Periodic Appointments TXT_PRIVAT: type: string maxLength: 1 description: Private text exists flag CLASS_ID: type: string maxLength: 1 description: 'Visibility for Other Users enumValues: 2=private,1=public,3=secret' enum: - '2' - '1' - '3' BD_ACCS_ID: type: string maxLength: 1 description: 'Changeability of Appointment Description, Obsolete enumValues: 2=Can be changed by the organizer,1=Can be changed by all participants' enum: - '2' - '1' MAINT_ID: type: string maxLength: 1 description: Obsolete STATUS: type: string maxLength: 1 description: 'Appointment Management: Status of an Appointment enumValues: 1=Taking Place,3=Canceled,2=Planned' enum: - '1' - '3' - '2' PART_STAT: type: string maxLength: 1 description: 'Appt. Management: Reply Status of Group Appt. Participants enumValues: 3=Declined,9=No Reply,2=With Reservation,1=Accepted' enum: - '3' - '9' - '2' - '1' PART_ROLE: type: string maxLength: 1 description: 'Appt. Management: Attendance of Group Appt. Participant enumValues: 3=Optional Participant,2=Required Participant,9=No Participants' enum: - '3' - '2' - '9' PART_SNDML: type: string maxLength: 1 description: 'Inform Participants by E-Mail enumValues: ""=Do Not Send Mail,X=Send Mail' enum: - '' - X INFO_ID: type: string maxLength: 1 description: 'Indicator: Substitution Active enumValues: ""=Not Selected,X=Selected' enum: - '' - X ADMIN_ID: type: string maxLength: 40 description: Documentation in the Administration Part PRIORITY: type: integer format: int64 description: Appointment priority ENTRY_BY: type: string maxLength: 12 description: Creator CHANGE_BY: type: string maxLength: 12 description: Last changed by DOMINANT: type: string maxLength: 1 description: 'All-Day Event enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' EXIT_INFO: type: string maxLength: 60 description: User exit information DATE_FROM: type: string format: date description: Start Date TIME_FROM: type: string maxLength: 6 description: From Time ZONE_FROM: type: string maxLength: 6 description: 'Appointment calendar: Time zone of start of appointment' TST_FROM: type: integer format: int64 description: Time Stamp (UTC) of Start Time of Appointment DATE_TO: type: string format: date description: End Date TIME_TO: type: string maxLength: 6 description: To Time ZONE_TO: type: string maxLength: 6 description: 'Appointment calendar: Time zone of end of appointment' TST_TO: type: integer format: int64 description: Time stamp of end of appointment ENTRY_DAT: type: string format: date description: Creation date ENTRY_TIM: type: string maxLength: 6 description: Creation Time ENTRY_TST: type: integer format: int64 description: Time stamp of creation CHANGE_DAT: type: string format: date description: Changed On CHANGE_TIM: type: string maxLength: 6 description: Last changed at CHANGE_TST: type: integer format: int64 description: Time Stamp of Change Time SHOW_LOCAL: type: string maxLength: 1 description: 'Display appointment in the local time of the appointment enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' BUSY: type: string maxLength: 1 description: 'Status for Search for Times Without Appointments enumValues: 0=Available,2=Reserved' enum: - '0' - '2' SEQUENCE: type: integer format: int32 description: Number of Times an Appointment Has Been Updated APPL_GUID: type: string format: byte description: GUID (Hex) Specified by the Application APPT_GUID: type: string format: byte description: GUID of Appointment REQU_TEXT: type: string maxLength: 1 description: 'Appointment title required entry flag enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' REQU_ROOM: type: string maxLength: 1 description: 'A Room Must Be Specified for Appointments of this Type enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CREATEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CREATEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CHANGEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_CHANGEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_DELETEE: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' NO_DELETEI: type: string maxLength: 1 description: 'Locked Functions for this Appt. Type in SAP or Externally enumValues: X=Value for activated,""=Value for deactivated' enum: - X - '' COLOR: type: integer format: int32 description: 'Appointment Management: Color of Appts. of Certain Types enumValues: 7=Red,8=Violet,1=Background,4=Yellow,5=Blue-green,3=Light gray,2=Gray-blue,6=Green' enum: - '7' - '8' - '1' - '4' - '5' - '3' - '2' - '6' ICON: type: string maxLength: 4 description: 'Appointment Management: Icon for Appts of Certain Types' FUNCMODULE: type: string maxLength: 30 description: Name of function module APPT_GROUP: type: string maxLength: 12 description: Technical Name of Appointment Type Group TXT_LONG: type: string maxLength: 40 description: Description CONTACT: type: string maxLength: 10 description: Obsolete MAINT_INDI: type: string maxLength: 1 description: Maintenance identifier MARK_INDI: type: string maxLength: 1 description: Maintenance identifier OWNER_OR_DISTR_LIST: type: array items: type: object properties: OWNER: type: string maxLength: 12 description: Owner of an Appointment Calendar DISTR_INDI: type: string maxLength: 1 description: 'Address Type enumValues: A=External address,O=SAPoffice user,""=Address name,C=Shared distribution list,B=SAP user,P=Private distribution list' enum: - A - O - '' - C - B - P LOGSYS: type: string maxLength: 10 description: Logical system OBJTYPE: type: string maxLength: 10 description: Object Type OBJKEY: type: string maxLength: 70 description: Object key STATUS: type: string maxLength: 1 description: 'Appt. Management: Reply Status of Group Appt. Participants enumValues: 3=Declined,9=No Reply,2=With Reservation,1=Accepted' enum: - '3' - '9' - '2' - '1' ROLE: type: string maxLength: 1 description: 'Appt. Management: Attendance of Group Appt. Participant enumValues: 3=Optional Participant,2=Required Participant,9=No Participants' enum: - '3' - '2' - '9' SEND_MAIL: type: string maxLength: 1 description: 'Inform Participants by E-Mail enumValues: ""=Do Not Send Mail,X=Send Mail' enum: - '' - X EXTERN_FB: type: string maxLength: 1 description: 'Get External Free/Busy Dates (Using The Address Management) enumValues: X=Flag set. Event has occurred.,""=Flag is Not Set' enum: - X - '' ADDRNUMBER: type: string maxLength: 10 description: Address number PERSNUMBER: type: string maxLength: 10 description: Person number COMM_MODE: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) CONSNUMBER: type: integer format: int64 description: Sequence number OWNER_NAME: type: string maxLength: 120 description: User name (external format) '400': description: Bad request. 5XX: description: Unexpected error.