logo
Platform 6
REST API Guide
Initializing search
    • Intro to Platform 6
    • Tutorials
    • Reference
    • Community
    • Releases
      • What is Platform 6?
      • What can P6 do?
      • How does P6 work?
      • Why use Platform 6?
      • Use cases
        • Install a P6 instance
        • Installation troubleshooting
        • Configuration
        • Learn with the Demo App
        • Connect to a Public Blockchain
        • IntelliJ and Gradle
        • Using the DSL API and Groovy Classes
        • Integration Testing
        • Intro to P6 apps
        • Create & assign an app profile
        • Set your default app profile
        • Design and implement your transaction flow
        • Customize the UI
        • Packaging
        • Lifecycle
        • Magic Links
      • Architecture
        • Overview
          • Guide
          • Guide
          • Guide
          • Guide
          • Guide
          • Guide
          • User Interface
          • Cron Scheduling
          • Guide
          • Guide
          • User Interface
          • Guide
          • Guide
          • Guide
          • Guide
          • Guide
          • User Interface
          • Routes DSL
            • File
            • FTP
            • JSON
            • P6Cmb
            • P6Rest
            • P6Route
            • P6log
            • P6Sftpd
            • P6Ftpd
            • Quartz & Timer
            • Web3j
          • Advanced Topics
          • FTP Consumer Events
          • Routes in a Clustered Deployment
          • Idempotent Consumer EIP
          • Guide
          • Routing Order Process Flows
          • Guide
          • Libraries
          • Importing
          • Testing
          • Guide
          • User Interface
          • Guide
          • Guide
          • Overview
          • Permissions
          • Permission Sets
          • Scopes and Permissions
          • Users
          • User Security Profiles
          • Single Sign On (SSO)
          • Example SSO Configurations
          • Example Exchange Token Federation Configurations
          • Webhooks
          • Example Webhook Configurations
          • Guide
          • Searchable Types
          • User Interface
          • Overview
            • Guide
            • User Interface
            • XML Config
            • Workflow Tasks Guide
        • Create a Custom Service
        • Platform 6 Connectors
        • Platform 6 UI Components
        • Service Items
          • REST API Guide
          • System Authentication
          • User Authentication
          • Swagger Authentication
            • Get the Portal
            • List Items
            • Delete Items
            • Export Items
            • Import Items
            • Get an Item
            • Add an Item
            • Update an Item
            • Rename an Item
            • Duplicate an Item
            • Delete an Item
        • Guide
          • Antivirus
          • Application
          • Application Configuration
          • AS2
          • AS4 Peppol
          • Audit Trail Records
          • Bundled Resource
          • Button
          • Camel
          • Chart
          • Configuration
          • Conversion
          • Counter
          • CSV
          • Email
          • Excel
          • FreeMarker
          • Instance
          • ICRF
          • I18n
          • IDoc
          • Job
          • Lock
          • Log
          • Map
          • Open PGP
          • Organizational Tree
          • PDF
          • PIDX RNIF
          • Pipeline
          • Permissions
          • Routing Orders
          • Script
          • Script's resource
          • Secure Socket
          • Service
          • Smooks Templates
          • Stored Procedure
          • Table
          • Transaction
            • PHIVE XML Validation Provider
          • URI
          • Users
          • Utils
          • Views
          • Version
          • Web3 Besu
          • Web3 Ethereum
          • Web3 Quorum
          • Workflow
          • XML Split
          • XSLT
          • Custom Binding
          • Exception and Assertion
          • FixedLengthSlurper
        • CMB API Guide
          • Application Configuration
          • Applications
          • Auditing
          • Bundled Resources
          • Buttons
          • Charts
          • Counters
          • Data Models
          • Email
          • Forms
          • Frames
          • Home Pages
          • Routes
          • Routing Orders
          • Scripts
          • Stored Procedures
          • Tables
          • Transactions
          • Views
          • Workflow Steps
        • Common Service
        • Foreign Service Deployment
        • Monitor a P6 instance
        • Run P6 in failover mode
        • Database
          • Audit Providers Guide
          • Elasticsearch
          • Google BigQuery
        • Service Status Header
        • Jobs Control Panel
          • Intro to P6 Cmd
          • Intro to P6 Sync
          • Desktop Development and Version Control
          • Push and Pull Operations Explained
        • Message Submission
      • Internationalization
      • Glossary
      • Where to Get Support
      • Release Notes
      • Migration Troubleshooting
        • P6 Core 6.10.3
        • P6 Core 6.10.2
        • P6 Core 6.10.1
        • P6 Core 6.9.9
        • P6 Core 6.9.8
        • P6 Core 6.9.7
        • P6 Core 6.9.6
        • P6 Core 6.9.5
        • P6 Core 6.9.4
        • P6 Core 6.9.3
        • P6 Core 6.9.2
        • P6 Core 6.9.1
        • P6 Core 6.9.0
        • P6 Core 6.8.25
        • P6 Core 6.8.24
        • P6 Core 6.8.23
        • P6 Core 6.8.22
        • P6 Core 6.8.21
        • P6 Core 6.8.20
        • P6 Core 6.8.19
        • P6 Core 6.8.18
        • P6 Core 6.8.17
        • P6 Core 6.8.16
        • P6 Core 6.8.15
        • P6 Core 6.8.14
        • P6 Core 6.8.13
        • P6 Core 6.8.12
        • P6 Core 6.8.11
        • P6 Core 6.8.10
        • P6 Core 6.8.9
        • P6 Core 6.8.8
        • P6 Core 6.8.7
        • P6 Core 6.8.6
        • P6 Core 6.8.5
        • P6 Core 6.8.4
        • P6 Core 6.8.3
        • P6 Core 6.8.2
        • P6 Core 6.8.1
        • P6 Core 6.8.0
        • P6 Core 6.7.6
        • P6 Core 6.7.5
        • P6 Core 6.7.4
        • P6 Core 6.7.3
        • P6 Core 6.7.2
        • P6 Core 6.7.1
        • P6 Core 6.7.0
        • P6 Core 6.6.1
        • P6 Core 6.6.0
        • P6 Core 6.5.2
        • P6 Core 6.5.1
        • P6 Core 6.5.0
        • P6 Core 6.4.4
        • P6 Core 6.4.3
        • P6 Core 6.4.2
        • P6 Core 6.4.1
        • P6 Core 6.4.0
        • P6 Core 6.3.7
        • P6 Core 6.3.6
        • P6 Core 6.3.5
        • P6 Core 6.3.4
        • P6 Core 6.3.3
        • P6 Core 6.3.2
        • P6 Core 6.3.1
        • P6 Core 6.3.0
        • P6 Core 6.2.2
        • P6 Core 6.2.1
        • P6 Core 6.2.0
        • P6 Core 6.1.2
        • P6 Core 6.1.1
        • P6 Core 6.1.0
        • P6 Core 6.0.6
        • P6 Core 6.0.5
        • P6 Core 6.0.4
        • P6 Core 6.0.3
        • P6 Core 6.0.2
        • P6 Core 6.0.1
        • P6 Core 6.0.0
        • P6 Core 6.0.0-beta-2
        • P6 Core 6.0.0-beta-1
        • P6 Core 6.0.0-alpha-5
        • P6 Core 6.0.0-alpha-4
        • P6 Core 6.0.0-alpha-3
        • P6 Core 6.0.0-alpha-2
        • P6 Core 6.0.0-alpha-1

    REST API Guide

    This section describes the abstract API resources used by every service.

    Note

    Each request must include a token inside the access_token header in other to authenticate the caller towards Platform 6.

    Manage the service:

    • Get the portal

    Manage several items:

    • List the items
    • Delete items
    • Export items
    • Import items

    Manage a specific item:

    • Get an item
    • Add an item
    • Update an item
    • Rename an item
    • Duplicate an item
    • Delete an item
    © Amalto Technologies SA
    Made with Material for MkDocs