Skip to main contentSkip to search
Powered by Zoomin Software. For more details please contactZoomin
Progress DocumentationProgress Documentation
Progress Documentation
  • Home
  • Home
  • EnglishČeštinaDeutsch (Germany)Español (Spain)ФранцузскийItaliano (Italy)Português (Brasil)日本語Русский (Russia)中文 (简体) (China)中文 (繁體, 台灣) (Taiwan)ar-AR
  • Login

Progress Developer Studio for OpenEdge Online Help

REST service annotations

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents
  • Learn About Progress Developer Studio for OpenEdge
    • Concepts
      • Eclipse terminology
      • Preferences and properties
      • Database connection profiles
      • The ABL Virtual Machine (AVM)
      • Get started with Progress Developer Studio for OpenEdge
      • Get help
        • Help display options
        • The Progress Developer Studio for OpenEdge Guide
        • Search
        • Context-sensitive help
        • Context-sensitive help for .NET controls (Windows only)
        • Visual Designer tutorials
        • Cheat sheets
        • OpenEdge information resources
        • Eclipse information resources
      • Introduction to Code Analyzer for ABL
    • Tasks
      • Start Progress Developer Studio for OpenEdge
        • Set Eclipse startup preferences
        • Select a workspace
      • Set workspace preferences
        • Set the default AVM startup parameters
        • Set up a shared AVM
        • Export the Workspace Settings
        • Import the Workspace Settings
      • Work with OpenEdge perspectives
        • Open a perspective
        • Modify a perspective
        • Set a perspective to its default state
      • View the log files
    • Reference
      • OpenEdge workspace preferences
        • Views preference page
        • Startup preference page
        • Database connections preferences
        • Shared AVM preference page
          • Shared AVM properties
          • Projects page
        • Preference pages for OpenEdge tools
      • OpenEdge database connection wizard
        • Add/Edit OpenEdge database connection profile wizard
        • Define a SQL connection profile
        • Add a SQL connection profile
        • Define an OpenEdge database server configuration
      • OpenEdge perspectives and views
        • OpenEdge default perspectives
        • OpenEdge views
  • Learn About OpenEdge Projects
    • Concepts
      • OpenEdge project and resource data files
      • Configuration variables
      • OpenEdge DevOps Framework
        • OpenEdge DevOps Framework configuration file
        • OpenEdge DevOps Framework configuration parameters
      • Project type options for application development
        • Custom project type
        • ChUI project type
        • GUI for .NET Framework project type for Windows
        • .NET project type
        • OpenEdge project type
    • Tasks
      • Create a new OpenEdge project
        • Create a ChUI project
        • Create a GUI for .NET Framework project for Windows
        • Create a .NET project
        • Migrate a .NET Framework project to .NET project
        • Create a standard OpenEdge project
        • Create a custom project
        • Create an AppBuilder project
      • Add resources to a project
      • Add existing database connections to a project
      • Add a new database connection to a project
      • Set project properties
      • Save project property profiles
      • Change project property profiles
        • Export and import project resources and properties
          • Share project properties
          • Import resources
          • Export projects
          • Import projects
          • Export database connections
          • Import database connections
          • Import breakpoints
      • Define new configuration variables
    • Reference
      • New OpenEdge Project wizard
        • Create an OpenEdge Project page
        • Select AVM and layout options page
        • Define PROPATH page
        • Select database connections page
        • Review custom project layout page
        • Project Facets page
      • Project properties pages
        • Progress OpenEdge properties page
        • AppBuilder properties page (Windows only)
        • Assemblies properties page (Windows only)
        • Build properties page
        • Configuration variables properties page
        • Configuration Variables preferences
        • Database connections properties page
        • File Destinations properties page
        • Modules properties page
        • PROPATH properties page
        • SpeedScript properties page
      • Project Facets of Project Properties page
      • Progress OpenEdge Import and Export wizards
        • Import data definitions page
        • Import workspace database connections page
        • Import shared AVM settings page
        • Import Workspace OpenEdge Explorer connections page
        • Export Data Definitions page
        • Export workspace database connections page
        • Export shared AVM settings page
        • Export Workspace OpenEdge Explorer connections page
      • Build and Compile options
  • Learn About PAS for OpenEdge
    • Concepts
      • What is PAS for OpenEdge?
      • The PAS for OpenEdge Server perspective
      • PAS for OpenEdge launch configuration
      • Project support for PAS for OpenEdge
      • Terminology related to PAS for OpenEdge
      • Overview of WebSpeed support in PAS for OpenEdge
    • Tasks
      • Create a PAS for OpenEdge instance
      • Add an OpenEdge Explorer connection
      • Define the OpenEdge AVM runtime
      • Access OpenEdge Explorer
      • Define a PAS for OpenEdge's runtime environment
      • Rename a PAS for OpenEdge instance
      • Publish modules and services on PAS for OpenEdge
        • Delete a PAS for OpenEdge instance
      • View PAS for OpenEdge log files
      • Work with PAS for OpenEdge launch configuration
        • Access the PAS for OpenEdge launch configuration
      • Work with ABL WebApp
        • Create an ABL WebApp project
        • Create an ABL REST Service
        • Create a WebHandler Class
        • Export an ABL Service
        • Migrate a REST Project to ABL WebApp Project
        • Migrate a Data Object Project to ABL WebApp Project
        • Upgrade an ABL WebApp project
      • Work with Web UI Project Type
        • Create a Web UI project
        • Export a Web UI project
        • Migrate an existing project to a Web UI project
        • Publish a Web UI project
          • PAS for OpenEdge server editor
        • Launch the OpenEdge web app
        • Undeploy a Web UI project
        • Delete a published Web UI project
    • References
      • PAS for OpenEdge preferences
        • Server Runtime Environments preferences
        • PAS for OpenEdge server preferences
        • OpenEdge Explorer connections preferences
        • ABL Service Project Property page
      • PAS for OpenEdge launch configuration settings
        • Server tab (PAS for OpenEdge)
        • Startup tab (PAS for OpenEdge)
        • PROPATH tab (PAS for OpenEdge)
        • Databases tab (PAS for OpenEdge)
      • PAS for OpenEdge debug configuration settings
      • WebHandler Class
      • Progress OpenEdge Server Monitor view
      • Update transport properties
      • Use Apache Ant tasks
        • Package an ABL WebApp ANT project
        • Package REST services
        • Generate a Data Object Service Catalog file
        • Package a Web UI project
  • Learn About OpenEdge REST
    • Concepts
      • Project support for REST
      • REST project type
      • Terminology related to REST support
      • REST service artifacts
      • REST service annotations
        • REST main annotations
        • REST detail annotations
      • Default parameter mapping
    • Tasks
      • Build a REST Web application
      • Create a REST project
      • Create a REST project with Project Facets
      • Develop an ABL REST Web applications
        • Define an ABL REST service annotations
        • Define an ABL REST service
        • Work with the REST Expose Editor
          • Open the REST Expose Editor
          • Use the REST Expose Editor
          • Modify service relative URI
          • Add REST resources
          • Add REST parameters
          • Change a REST resource name
          • Delete a REST resource
          • Associate REST verbs with operations
          • Map REST resource verb parameters
          • Manage nodes
      • Deploy ABL REST Web applications
        • Create a PAS for OpenEdge instance
        • Publish an ABL REST service
        • View REST service URI
      • Package ABL REST Web applications
        • Export a REST application
      • Work with REST services
        • Undeploy REST services
        • Delete a REST service
    • Reference
      • New REST Service dialog
      • REST Expose Editor dialogs
        • REST Expose Editor
        • Edit Service Relative URI dialog
        • New REST Resource dialog
        • Associate Operation With Verb dialog
      • PAS for OpenEdge related dialogs and context menu
        • PAS for OpenEdge server Editor
        • PAS for OpenEdge instance context menu
        • Add and Remove dialog
      • Progress OpenEdge Server Monitor view
        • PAS for OpenEdge server statistics
        • REST service statistics
      • Status of PAS for OpenEdge instance and ABL REST service
      • PAS for OpenEdge instance and REST service logs
  • Learn About ABLUnit Test Framework
    • Concepts
      • Test Class
      • Test Suite Class
      • Test Procedure
      • Test Suite Procedure
      • Annotations supported with ABLUnit
      • Lifecycle of ABLUnit framework
      • ABLUnit project type
    • Tasks
      • Access ABLUnit perspective
      • Create an ABLUnit project
      • Create test cases using ABLUnit
      • Run test cases and test suites
        • Run test cases from OpenEdge
          • Access Progress OpenEdge ABLUnit launch configurations
          • Define and run a new ABLUnit launch configuration
          • Add an ABLUnit launch configuration to the Run menu
          • Copy or deleting ABLUnit launch configurations
        • Run test cases from the command prompt
        • Run test cases using an Apache ANT task
      • Use the ABLUnit view
    • Reference
      • Test case generation wizards
        • New ABLUnit Test Class wizard
        • New ABLUnit Test Case Procedure wizard
        • New ABLUnit Test Suite Class wizard
        • New ABLUnit Test Suite Procedure wizard
      • ABLUnit view
      • Progress OpenEdge ABLUnit launch configuration settings
      • Progress OpenEdge ABLUnit debug configuration settings
      • Add New Test Method wizard
      • Add New Test Procedure wizard
      • Assert API
  • Learn About ABL WebApp
    • Concepts
      • Prerequisites for ABL WebApp project support
      • Terminology related to ABL WebApp support
      • ABL WebApp project type
      • ABL WebApp project folder structure
      • ABL Service artifacts
      • ABL Web Application WAR file structure
    • Tasks
      • Work with ABL WebApp
        • Create an ABL WebApp project
          • Add WebSpeed functionality in ABL WebApp project
          • Deploy ABL WebApp project with WebSpeed functionality
        • Define ABL WebApp resources
          • Create a Business Entity class
            • Create a Business Entity class from a database table
            • Create a Business Entity class from the schema file
          • Use the Define Service Interface wizard
        • Create an ABL Service
        • Edit an ABL Service
        • Delete an ABL Services
      • Deploy ABL Services
        • Start and stopping PAS for OpenEdge server
        • Publish ABL services
      • Export an ABL Web Application
    • Reference
      • New Business Entity wizard
        • Create a Business entity class page
        • Select a schema file page
      • Define Service Interface wizard
        • Define Service Interface page
        • Edit Annotation page
      • New ABL Service wizard
      • ABL Service context menu
      • Export ABL Web Application wizard
      • Add and Remove dialog
      • Data Service Catalog schema properties
        • foreignkey property
        • method property
        • primarykey property
        • required property
        • Entity property
        • Field property
  • Learn About OpenEdge Business Rules
    • Concepts
      • Terminology related to OpenEdge Business Rules
    • Tasks
      • Integrate Corticon Studio and Progress Developer Studio for OpenEdge
      • Configure Corticon Server on PAS for OpenEdge
      • Generate Business Rules Vocabulary Definition
      • Use Outline view to generate Business Rules Vocabulary Definition
      • Export Business Rules Vocabulary Definition
      • Set Business Rules preferences
      • Use Business Rules API to invoke Decision Services
      • Add Business Rules libraries to PROPATH
    • Reference
      • Export Business Rules Vocabulary Definition wizard
      • Generate Business Rules Vocabulary Definition wizard
      • OpenEdge Business Rules API reference
        • Class and Interface reference
          • OpenEdge.BusinessRules.DecisionService class
          • OpenEdge.BusinessRules.RulesServerConnection class
          • OpenEdge.BusinessRules.RulesServerConnectionParameters class
          • OpenEdge.Core.ServerConnection.FormatMaskEnum class
          • OpenEdge.Core.ServerConnection.IconnectionParameters interface
          • OpenEdge.Core.ServerConnection.IServerConnection interface
          • OpenEdge.Core.ServerConnection.WebServiceServerConnection class
          • OpenEdge.Lang.EnumMember class
          • OpenEdge.Lang.WidgetHandle class
        • Class Properties and Methods reference
          • ABLConnect property
          • AdminServiceConnectionParameters property
          • Connected property
          • ConnectionParameters property
          • Custom property
          • DashSpace property
          • DecisionServiceConnectionParameters property
          • Default property
          • DoubleDashEquals property
          • DoubleDashSpace property
          • EffectiveOn property
          • FormatMask property
          • Name property
          • NameEquals property
          • None property
          • Operation property
          • PortName property
          • Server property
          • ServerConnection property
          • ServiceName property
          • Value property
          • Version property
          • CreateServer() method
          • Connect() method
          • DestroyServer() method
          • Disconnect() method
          • GetConnectionString() method
          • GetMessages() method
          • InvokeService() method
          • IsServiceAvailable() method
          • ToString() method
  • Learn About ABL Editor
    • Concepts
      • ABL Resources in Progress Developer Studio for OpenEdge
        • Procedural code
        • Object-oriented code
        • GUI for .NET code (Windows only)
        • AppBuilder code
        • Excluded resources
      • Exclude PROPATH entry from OpenEdge tooling
      • Developer features of Progress Developer Studio for OpenEdge
        • Format and display features
        • Navigation features
        • Code assistance
        • Code annotations
        • Code parsing
        • Support for structured error handling
        • Finding references
        • ABLDoc documentation generation
        • The OpenEdge Editor perspective
        • AI Coding Assistant with Developer Studio
          • Troubleshoot AI Coding Assistant with Developer Studio
    • Tasks
      • Set Editor options
        • Set Eclipse editor preferences
        • Set ABL Editor preferences
        • Associate custom file extensions with the ABL Editor
      • Write ABL code
        • Create ABL source files
        • Use comments
        • Use templates for easier text entry
        • Compare files
        • Remove AppBuilder markup
        • Write procedural code
          • Add functions
          • Add internal procedures
        • Write object-oriented code
          • Add constructors
          • Add constructors from a super class
          • Add a destructor
          • Add methods
          • Add events
          • Add properties
          • Override members
          • Code members implemented via interface or abstraction
        • Use assistance features
          • Use context assistance
            • Show syntax help as you type
            • Use bracket-matching
            • Use hover help
          • Use code-completion assistance
            • Invoke syntax-completion assistance
            • Use auto-bracketing
            • Balance code-completion convenience and performance
        • Work with databases
          • Use the DB Structure view
          • Enter schema references
        • Format and displaying code
          • Use code folding
          • Apply keyword casing
          • Format the Source
          • Expand abbreviated keywords
          • Indent and align code
          • Select display color for code element
        • Enable AI Coding Assistant with Developer Studio
          • Use ChatGPT view
          • Discuss code using AI Coding Assistant with Developer Studio
        • Navigate
          • Use the Outline view
          • Go to a specific line number
          • Open include files
          • Use Quick Outline
            • Display Quick Outline
            • Expand Include files
            • Show inherited members
            • Show preprocessors list
            • Use Filter Preferences
        • Work with preprocessor elements
          • Enable preprocessor evaluation
          • View preprocessors in ABL source files
          • View preprocessors in the Outline view
          • List preprocessors in Quick Outline
          • Use the ABL Preprocessor view
        • Use annotations
          • Add templates for code annotations
          • Add annotations to source files
          • Add Sonic ESB annotations
        • Work with Organize USING Statements
          • Organize USING Statements
          • Add USING Statements to ABL resources
          • Specify keyword casing for USING Statements
          • Set preferences for USING Statements
      • Compile, test, and run ABL programs
        • Check syntax
        • Compile ABL code
          • Set Compile options preferences
          • Compile files with errors
        • Set breakpoints while editing
        • Clear OpenEdge errors
        • Run and debug programs
        • Exclude resources from the build
          • Exclude resources from the context menu
          • Exclude resources using Exclusion Pattern Selection
          • Exclude resources using Add Resource Exclusions
        • Include resources in the build
          • Include resources using the context menu
          • Include resources using the Source tab
        • Build resources using working sets
          • Create a new working set
          • Build a working set automatically
          • Build a working set manually
        • Find references to ABL constructs
          • Use the Search view
        • Generate ABLDoc documentation
          • Generate the ABLDoc documentation using the Generate ABLDoc wizard
          • Generate ABLDoc using Apache Ant
            • ABLDoc task-level properties
            • ABLDoc elements
            • Sample ABLDoc Ant task
          • Navigate through the ABLDoc Navigation page
          • Add comments
            • Add comments to the Overview page:
            • Add comments to a package
            • Add comments to a file
            • Add comments to elements
          • Customize ABLDoc output
            • Customize templates and .css files
            • Add a custom serializer class
            • Customize tag parser
    • Reference
      • ABL Editor preferences
        • Editor options
        • Editor Annotations options
        • Editor Assistance options
        • Editor Build options
        • Editor Code Formatter options
        • Editor Colors options
        • Editor Templates (Macros) options
        • Class Cache options
        • Parsing options
        • USING Statements options
      • ABL Editor menus
        • Source menu
        • ABL Editor context menu
        • Progress OpenEdge context menu
      • Code-generation wizards
        • Add Annotation wizard
        • Add Constructor wizard
        • Add Constructors from Super Class wizard
        • Add Event wizard
        • Add Function wizard
        • Add Method wizard
        • Add Procedure wizard
        • Add Property wizard
        • New ABL Class wizard
        • New ABL Include wizard
        • New ABL Interface wizard
        • New ABL Procedure wizard
        • New ABL Structured Include wizard
        • New ABL Structured Procedure wizard
        • Override/Implement Members wizard
        • Generate ABLDoc wizard
      • Profiler Viewer
        • Module Details tab
        • AVM Information tab
        • Call Tree tab
      • ABL Scratchpad view
      • Hot keys
      • Line Summary view
  • Learn About Visual Designer
    • Concepts
      • Benefits of the Visual Designer
      • Code associated with a Visual Designer component
      • .NET assemblies and the Visual Designer
      • Visual container types
      • Implement the OpenEdge GUI for .NET in your application
      • Application run-time environment
      • UI controls
        • Visual and non-visual controls
        • Container controls
        • Data-bound controls
        • Custom user-defined controls
        • Control properties
        • Event behavior
        • Access to controls
      • The Visual Designer tool set
        • Visual Designer components
        • The Visual Designer perspective
        • Additional tools
    • Tasks
      • Develop a visual container
        • Create the container
        • Open an existing container
        • Size the container
        • View and edit the container's source code
        • Delete a container
        • Work with UI controls
          • Use the Toolbox
          • Get control-specific information
          • Use built-in design tools
          • Use the Undo and Redo options
          • Test a UI design
          • Create custom controls
            • Create a user control
            • Create an inherited control
            • Reload the Design Canvas while using custom controls
          • Choose controls for the UI
            • Add controls to a container
            • Delete controls from a container
          • Define properties and appearance
            • Select objects on the Design Canvas
            • Use the Outline view
            • Size objects
            • Position objects on a container
              • Directly moving objects by dragging or by using the arrow keys
              • Space objects
              • Align objects
              • Order layers of objects
              • Dock objects
            • Set tab order
            • Use the Properties view
              • View properties and events in the Properties view
              • Sort the property and event list in the Properties view
              • Set Property values in the Properties view
          • Link controls to data
            • Create a binding source object
              • Drag-and-drop schema definition
              • Manually defining the schema
              • Import a schema
            • Edit a ProBindingSource control
            • Bind to an ABL data source
            • Data binding example
            • Define recursive relation
              • Define a recursive relation between tables
              • Rename the recursive relation between tables
              • Delete a recursive relation between tables
          • Code event logic
            • Create event subscriptions
            • Code event methods
      • Customize the Visual Designer Toolbox
        • Share Toolbox settings
        • Manage control groups
        • Manage controls
          • Add controls to a control group
          • Rename controls
          • Delete controls from a control group
          • Rearrange controls among groups
          • Disable controls
        • Protect Toolbox customizations
        • Restore default Toolbox settings
        • Choose the Toolbox docking position
      • Work with .NET resources
        • Get information from the Class Browser
        • Add and remove assembly references
        • Update assembly references
          • Launch the Update Assembly References tool
          • Choose files to update
          • Update references to Progress assemblies
          • Update references to Telerik assemblies
          • Update references to third-party assemblies
          • Restart and recompile
    • Reference
      • Visual Designer Preferences
      • OpenEdge GUI for .NET wizards
        • New ABL Form wizard
        • New ABL Dialog wizard
        • New ABL MDI Form wizard
        • New ABL User Control wizard
        • New ABL Inherited Control wizard
        • ProBindingSource Designer
        • Use the Available Schema pane
      • Workspace components
        • Visual Designer Editor
        • Visual Designer Properties view
        • Add Controls dialog
  • Learn About Class Browser
    • Concepts
      • The Class Browser view
      • External resources and the Class Browser
    • Tasks
      • Access the Class Browser
      • View information in the Class Browser
        • Browse by resource
        • Browse by project
        • Show members
      • Add external resources
      • Remove an external resource
      • Search in the Class Browser
      • Copy to the Clipboard
    • Reference
      • Browser pane
      • Content pane
      • Summary pane
      • Class Browser toolbar
      • Class Browser view icons
      • Add external resources dialog
  • Run and Debug ABL Programs
    • Concepts
      • Launch configurations for running and debugging programs
        • Access launch configuration functions
        • Essential launch configuration settings
        • How OpenEdge creates or reuses a configuration
      • Progress Developer Studio for OpenEdge Debugger
        • The OpenEdge Debugger perspective
        • Prerequisites for using the Debugger
        • OpenEdge Debugger preferences
        • Remote debugging support in Progress Developer Studio for OpenEdge
          • Attachable Debugger
          • SpeedScript debugging
        • Debug operations
          • Options for controlling program execution
            • Breakpoints
            • Code-stepping
          • Options for monitoring results
          • Code changes while debugging
    • Tasks
      • Use launch configurations
        • Run or debug a program
          • Let OpenEdge launch the program automatically
          • Select an existing launch configuration
          • Define and run a new launch configuration
        • Manage launch configurations
          • Define a launch configuration
          • Create project-standard and program-specific configurations
          • Add a configuration to the menu
          • Copy and delete launch configurations
          • Set launch configuration preferences
      • Use the Progress Developer Studio for OpenEdge Debugger
        • Set Debugger preferences
        • Enable debugging
        • Launch the Debugger
        • Configure r-code generation
        • Attach the Debugger to an external AVM
        • Control program flow
          • Use breakpoints
            • Set breakpoints
              • Set an at-line breakpoint
              • Set an on-error breakpoint
              • Set a watchpoint
            • Selectively enabling breakpoints
            • Manage breakpoints
          • Step through the code
        • Monitor program execution
          • Use the Debug view and stack trace
          • Use the Variables view
            • Select Variables view display information
            • Expand and collapsing the Variables view list
            • Evaluate a property in the Variables view
            • Filter the Variables view display
            • Temporarily changing values in the Variables view
            • Add watch expressions using the Variables view
            • Assign a value to a data member
            • Open the Variable Details dialog
          • Use the Variable Details dialog
          • Use watch expressions
          • Use the Dynamic Objects view
            • Start and stop dynamic object monitoring
            • Filter the Dynamic Object view display
        • Change program code
        • Go to a specific source line
        • Close a Debugger session
        • Close a remote debugging session
          • Suspend and disconnect the Debugger from an attached AVM
    • Reference
      • Launch configuration settings
        • Configurations wizard
          • Progress OpenEdge Application settings
            • Main tab (Application)
            • Startup tab (Application)
            • PROPATH tab (Application)
            • Databases tab (Application)
            • ABL tab (Application)
            • Culture tab (Application)
            • Performance tab (Application)
            • Logging tab (Application)
            • Environment tab (Application)
            • Common tab (Application)
            • Profiler tab (Application)
          • Progress External OpenEdge AVM settings (Debug Configuration only)
            • Connection tab (Progress OpenEdge External AVM)
            • Source tab (Progress OpenEdge External AVM)
            • Common tab (Progress OpenEdge External AVM)
        • Launch preferences
      • Debugger dialogs
        • Debug Preferences dialog
        • Variable Details dialog
        • Select Columns dialog
        • Set Value dialog
        • New Breakpoint dialog
        • Edit Breakpoint dialog
        • Add Watch Expression dialog
        • Edit Watch Expression dialog
        • Dynamic Object Monitoring dialog
        • Filter Objects dialog
        • Select Process dialog
        • Add Source dialog
        • Edit Source Lookup Path dialog
      • Debugger views
        • Debug view
        • Variables view
        • Breakpoints view
        • Expressions view
        • Dynamic Objects view
  • Learn About ABL GUI Designer
    • Concepts
      • Learn About AppBuilder
      • OpenEdge AppBuilder perspective
      • Benefits and limitations of GUI Designer
      • Code analysis in GUI Designer
      • Code conventions to generate AppBuilder code
      • Read-only code sections of AppBuilder-generated code
      • About SmartObjects
      • SmartObject instance
      • SmartObject master
      • Paging in SmartObjects
      • Layout
      • About Method Library
      • Common capabilities of SmartObjects
      • About custom object file
    • Tasks
      • Access the AppBuilder perspective
      • Set AppBuilder preferences
      • Set AppBuilder properties
      • Create an AppBuilder project
      • Work with AppBuilder procedure files
        • Create ABL GUI procedure files
        • Open ABL GUI procedure files
        • Edit ABL procedure files
        • Work with ABL procedure files
      • Work with objects
        • Access property sheets
        • Use the Undo and Redo options
        • View and edit code of an object
        • Choose objects for the design window
          • Add objects to the design window
          • Delete objects from the design window
        • Define properties and appearance
          • Edit object properties
          • Change color of an object
          • Change font for an object
          • Create an Alternate Layout
          • Select standard or alternate layout
          • Align objects
          • Set tab order
          • Select translation attributes for an object
          • Resize the design window
      • Work with the code
        • View and edit the source code
        • Add triggers
        • Rename an internal procedure or function
        • Use the Outline view
        • Toggle to the Section Editor mode
        • Use the Find/Replace dialog
        • Select a display color for the read-only code
      • Work with objects Palette
        • Choose the Palette docking position
        • Change the Palette settings
        • Choose Palette layout
        • Customize the Object Palette
      • Work with PRO*Tools
        • Add user-defined utilities
        • Show or hiding toolbar buttons and menu items
      • Insert SmartObjects
      • Run ABL procedure files
      • Insert Popup Menu or Menu Bar
      • Work with method library reference
        • Add method library reference
        • Modify method library reference
      • Work with custom object files
        • Add custom object files
        • Modify custom object files
        • Modify custom object files
      • View ABL messages
      • Open AppBuilder Properties view
      • Enable AppBuilder shortcut keys
      • Specify DB-Required code blocks
      • Edit a Freeform Query
    • Reference
      • AppBuilder perspective components
      • Preferences page
        • AppBuilder preferences
        • Editor preferences
        • Grid Units preferences
        • Widget ID preferences
      • Object Palette
        • Palette options
        • Palette context menu
        • Use Custom dialog
        • Types of objects
          • Basic static objects
          • ActiveX objects
          • SmartObjects
      • Toolbar and menu options
        • GUI Designer toolbar
        • Layout menu options
        • GUI Designer context menu
        • SmartObjects context menu
        • PRO*Tools utilities
          • General PRO*Tools utilities
          • AppBuilder PRO*Tools utilities
          • ADM2 PRO*Tools utilities
      • GUI Designer dialogs
        • AppBuilder dialogs
          • Tab Editor dialog
          • Procedure Settings dialog box
          • Advanced Procedure Settings Dialog Box
          • Property Sheet dialogs
            • Property Sheet for Window
            • Property Sheet for Dialog Box
            • Property Sheet for Menu Bar or Popup Menu
            • Property Sheet for Browse
            • Property Sheet for Button
            • Property Sheet for Combo Box
            • Property Sheet for Editor
            • Property Sheet for Fill In
            • Property Sheet for Frame
            • Property Sheet for Image
            • Property Sheet for Radio Set
            • Property Sheet for Rectangle
            • Property Sheet for Selection List
            • Property Sheet for Slider
            • Property Sheet for Text
            • Property Sheet for Toggle Box
            • Property Sheet for OCX
            • Property Sheet for SmartObjects
            • Other Settings section of Property Sheet dialog
          • Advanced Properties Sheet dialogs
            • Advanced properties for Window
            • Advanced properties for Dialog Box
            • Advanced properties for Browse
            • Advanced properties for Frame
            • Advanced properties for Rectangle
            • Advanced properties for Image
            • Advanced properties for Radio Set
            • Advanced properties for Toggle Box
            • Advanced properties for Slider
            • Advanced properties for Button
            • Advanced properties for Selection List
            • Advanced properties for Editor
            • Advanced properties for Combo Box
            • Advanced properties for Fill In
            • Advanced properties for Text
            • Advanced properties for OCX
          • Choose Color dialog
          • Character Terminal Simulator Colors dialog
          • Choose Font dialog
          • Choose Control dialog
          • Choose Template dialog
          • Table Selector dialog
          • Field Selector dialog box
          • Multi-Field Selector dialog
          • Add Trigger dialog
          • New ADM Class dialog
          • Progress Advisor dialog
          • Query Builder dialogs
            • Query Builder Dialog Box -- Join Mode
            • Query Builder Dialog Box -- Options Mode
            • Query Builder Dialog Box -- Sort Mode
            • Query Builder Dialog Box -- Table Mode
            • Query Builder Dialog Box -- Where Mode
          • Other AppBuilder dialogs
            • Add Directory to Path dialog
            • Calculated Field Editor dialog
            • Choose From File dialog
            • Code Sections Selector dialog
            • Column Editor dialog (for Browse)
            • Copy To File dialog
            • Data Dictionary window
            • Edit Path dialog
            • Enter Constant dialog
            • Enter Constant Range dialog
            • Enter Contain String dialog
            • Enter List of Constants dialog
            • Folder Selection dialog
            • Format dialog for Character field
            • Format a Date field
            • Format a Date Time-Tz field
            • Format a Date Time field
            • Format dialog for Logical field
            • Format dialog for Numeric field
            • Goto Page dialog
            • Method Libraries dialog
            • Record Menu Accelerators dialog
            • String Attributes dialog
            • Sync with Master dialog
            • Temp-Table Maintenance Dialog Box
            • View-as attributes dialog
            • Progress Advisor (Link Conflict)
            • Custom Lists dialog box
            • External Tables dialog box
            • Record Menu Accelerators dialog box
        • SmartObject dialogs
          • Open SmartObject dialog
          • SmartDataObject Wizard
          • SmartDataBrowser Wizard
          • SmartDataViewer Wizard
          • Property Sheet for SmartObjects
          • SmartObject Properties dialog
          • SmartDataObject Instance Properties dialog
          • DataView Instance Properties dialog
          • SmartFolder Instance Properties dialog
          • SmartPanel Instance Properties dialog
          • SmartDataViewer Instance Properties dialog
          • SmartFilter Instance Properties dialog
          • SmartBusinessObject Instance Properties dialog
          • SmartProducer Instance Properties dialog
          • SmartConsumer Instance Properties dialog
          • SmartRouter Instance Properties dialog
          • SmartSender Instance Properties dialog
          • Visual SmartObject dialog
          • SmartInfo dialog
          • SmartLinks dialog
          • Add a SmartLink dialog
          • Modify a SmartLink dialog
          • Modify Master File Name dialog
          • Help on Fields dialog
          • AppBuilder Queries
          • Help on DataObject
          • Preview SmartObject dialog box
      • Views
        • Outline view
          • Toolbar buttons
          • Context menu
        • ABL Cue Cards view
        • ABL Messages view
      • Other OpenEdge Tools
        • Audit Policy Maintenance Tool (Windows only)
        • Temp-DB Maintenance Tool
        • Database Administration Tool
        • Data Dictionary tool
        • OpenEdge Explorer Tool
        • Procedure Editor tool
        • Results Tool
  • Learn About Meta Catalog
    • Concepts
      • ABL Annotations
      • Access to catalog data
      • Content builders
      • Local and master catalogs
    • Tasks
      • Access Meta Catalog Explorer
      • Add custom file extensions to content builders
      • Add new files to a catalog
      • Build a master catalog
      • Change catalog definitions
      • Create a local catalog
      • Create templates for Annotation Generator
      • Link to a master catalog
      • Rebuild a local catalog
      • Search Meta Catalog
      • Set Meta Catalog preferences
      • Use Meta Catalog Explorer
    • Reference
      • ABL Annotation content builder
      • ABL annotation syntax
      • ABL Application Schema content builder
      • ABL Reference content builder
      • Annotation Generator
      • Meta Catalog database
      • Meta Catalog Explorer view
      • Meta Catalog preferences
      • Meta Catalog Search view
      • OECATALOG utility
  • Learn About Developer Studio Customization
    • Concepts
      • Menu and toolbar customization
      • Template customization
      • Startup customization
      • Event subscription
      • Custom project types
    • Tasks
      • Set customization preferences
      • Use the Customization Editor
        • Add menu and toolbar commands
        • Customize code templates
        • Work with custom project types
          • Create custom project types
          • Edit and remove custom project types
          • Import and export custom project types
        • Edit and delete options
        • Share customization settings
      • Customize project startup
    • Reference
      • Subscribe to OpenEdge Architect events
      • Customization Editor
        • Controls available in all contexts
        • Menu/Toolbar Entries or Editor Context Menu
        • New JET Templates options
        • Editor Templates options
        • Template Overrides options
        • OpenEdge Custom Project options
          • Folder Layout options
          • Code-generation Templates options
      • Customization Preferences page
  • Learn About Progress DB Navigator
    • Concepts
      • DB Navigator perspective
      • SQL connection profiles
      • JDBC drivers
      • Multitenancy (Progress OpenEdge databases only)
      • Table partitioning in Progress OpenEdge databases
    • Tasks
      • Common tasks for supported databases
        • Set preferences
        • Access the DB Navigator perspective
        • Launch OpenEdge Explorer (Progress Developer Studio for OpenEdge only)
        • Configure a JDBC driver
        • Connect a database
        • Work with SQL connection profiles
          • Add SQL connection profiles
          • Edit SQL connection profiles
          • Display SQL connection profiles
          • Open and close SQL connections
        • SQL scripting
          • Start the SQL editor
          • Generate SQL queries
          • Copy and paste
          • Generate a create table script
          • Save SQL scripts
        • Work with application data
          • View application data
          • Edit application data
      • Work with MS SQL Server databases
        • Set preferences
        • Add a SQL connection profile for an MS SQL Server database
        • Troubleshoot the MS SQL Server JDBC driver
        • View MS SQL Server database schema
          • Display MS SQL Server database function details
          • Display MS SQL Server database procedure details
          • Display MS SQL Server database session details
          • Display MS SQL Server database table details
          • Display MS SQL Server database triggers
          • Display MS SQL Server database view details
      • Work with OpenEdge databases
        • Set preferences
        • Add an SQL connection profile for an OpenEdge database
        • Troubleshoot the Progress OpenEdge JDBC driver
        • Create an OpenEdge database
        • Work with OpenEdge database user accounts
          • Create OpenEdge database user accounts
          • View OpenEdge database user account information
          • Change OpenEdge database user account passwords
          • Delete OpenEdge database user accounts
          • Grant privileges to OpenEdge database user accounts
          • Change privileges for OpenEdge database user accounts
        • View and maintain OpenEdge database schema
          • Work with OpenEdge database tables
            • Display OpenEdge database table details
            • Add OpenEdge database tables
            • Edit OpenEdge database table properties
            • Drop OpenEdge database tables
          • Work with multi-tenant tables
            • Display multi-tenant table details
            • Add multi-tenant tables
            • Edit multi-tenant tables
            • Identify multi-tenant tables
            • Convert tables to multi-tenant tables
            • Delete multi-tenant tables
          • Work with partitioned tables
            • Identify partitioned tables
            • Create partitioned tables without partition policies
            • Work with partitioned tables with partition policies
            • Drop partitioned tables
          • Work with OpenEdge database table columns
            • Display OpenEdge database column details
            • Add OpenEdge database columns
            • Edit OpenEdge database column details
            • Copy OpenEdge database columns
            • Drop OpenEdge database columns
          • Work with OpenEdge database indexes
            • Display OpenEdge database index details
            • Add OpenEdge database indexes
            • Edit OpenEdge database index properties
            • Drop OpenEdge database indexes
            • Enable OpenEdge database large index keys
          • Work with OpenEdge database sequences
            • Display OpenEdge database sequence properties
            • Add OpenEdge database sequences
            • Edit OpenEdge database sequences
            • Drop OpenEdge database sequences
          • Work with multi-tenant sequences
            • Display multi-tenant sequence properties
            • Add multi-tenant sequences
            • Edit multi-tenant sequences
            • Delete multi-tenant sequences
          • Work with OpenEdge database triggers
            • Display OpenEdge database triggers
            • Create OpenEdge database triggers
            • Edit OpenEdge database triggers
            • Drop OpenEdge database triggers
          • Import and export schema changes
      • Work with Oracle databases
        • Set preferences
        • Add an SQL connection profile for an Oracle database
        • Troubleshoot the Oracle JDBC driver
        • View Oracle database schema
          • Display Oracle database function details
          • Display Oracle database jobs details
          • Display Oracle database package body details
          • Display Oracle database package details
          • Display Oracle database procedure details
          • Display Oracle database sequence properties
          • Display Oracle database sessions details
          • Display Oracle database system parameter details
          • Display Oracle database table details
          • Display Oracle database TableSpace details
          • Display Oracle database Top SQL details
          • Display Oracle database triggers
          • Display Oracle database Users details
          • Display Oracle database view details
    • Reference
      • Components of the DB Navigator perspective
        • Connection dialog
        • Connection Info view
        • Connections view
        • DB Structure view
        • DB Details view
        • SQL Editor
        • SQL Results view
        • SQL History view
      • MS SQL Server database
        • MS SQL Server DB Details view
        • MS SQL Server DB Structure View
        • SQL terminology for ABL programmers
      • OpenEdge database
        • OpenEdge DB Details view
        • OpenEdge DB Structure view
        • OpenEdge edit schema wizards
          • OpenEdge Table wizard
          • OpenEdge Columns wizard
            • Character display format examples
            • Date display format examples
            • Logical display format examples
          • OpenEdge Index wizard
          • OpenEdge Add/Edit Sequence wizard
          • OpenEdge Create/Modify Trigger wizard
          • Field string attributes
      • Oracle database
        • Oracle DB Details view
        • Oracle DB Structure View
      • Preferences
        • DB Navigator preferences
        • SQL Connection profile preferences
        • JDBC Drivers preferences
        • OpenEdge Schema Editing preferences
        • SQL Editor preferences
Table of Contents

REST service annotations

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: March 13, 2026
  • 1 minute read
    • OpenEdge
    • Version 13.0
    • Documentation

The REST service annotations are @ Source-only annotations and fall into two categories: REST main annotations and REST detail annotations.

Contents
  • REST main annotations
  • REST detail annotations
TitleResults for “How to create a CRG?”Also Available inAlert