1. Home

Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name	path	methods	description
Plugins	/plugins /plugins/{pluginID}	GET GET
ProfiledDocuments	/projects/{usecase_id} /projects/{usecase_id}/configuration /projects/{usecase_id}/query /projects/{usecase_id}/search /projects/{usecase_id}/{project_id} /projects/{usecase_id}/deleteFiles/{project_id} /projects/{usecase_id}/forceUnlock/{project_id} /projects/{usecase_id}/registerFiles/{project_id} /projects/{usecase_id}/setAccess/{project_id} /projects/{usecase_id}/step/{project_id} /projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}	GET POST GET POST POST DELETE GET PATCH PUT POST PUT POST PUT POST DELETE GET PUT	The Class ProfiledDocuments.
UseCaseDescriptors	/ucd /ucd/query /ucd/{usecase_id}	POST POST DELETE GET PUT

Data Types

JSON

type	description
AbstractDeclarationImpl
Access
AccessPolicy
AccountingInfo
Adapter
AppInfo
AttachmentUnmarshaller
Attributes
BGMBuilder
BIClass
BIConversion
BIDeclaration
BIDom
BIEnum
BIEnumMember
BIEnumMember2
BIFactoryMethod
BIGlobalBinding
BIInlineBinaryData
BIProperty
BISchemaBinding
BISerializable
BIXDom
BIXSubstitutable
BaseTypeBean
BindInfo
BindingComponent
CAdapter
CBuiltinLeafInfo
CNonElement
ClashOptions
ClassNameAllocator
ClassNameBean
CollectionTypeAttribute
Compositor
Configuration
ContentHandler
Context
DataAccessPolicy
Documentation
EntityResolver
EnumMemberMode
Enumeration
ErrorListener
FieldRenderer
FieldRendererFactory
File
ForeignAttributes
GlobalStandardConversion
HandlerDeclaration
ImplStructureStrategy
InputSource
InputStream
Iterable
JAXBContext
Language
LifecycleInformation
LifecycleManagerDescriptor
Listener
LocalScoping
Locatable
Location
Locator
Lock
MimeType
MimeTypeParameterList
Model
NClass
NType
NameConverter
NameRules
NamingRule
NavigatorOfNTypeAndNClassAndVoidAndVoid
ObjectId
OperationDescriptor
OptionalPropertyMode
Options
PackageInfo
ParticleBinder
Plugin
PluginDescriptor
Policy
PolicyEnforcer
Project
PublicationInfo
Reader
RegisterFileSetRequest
Relationship
RelationshipDefinition
Schema
SchemaDocument
Semver
SemverType
SpecVersion
Status
Status
StepExecutionRequest
TempFile
Transformer
TriggeredEvents
Type
TypeSubstitutionElement
URIResolver
UnderscoreBinding
Unmarshaller
UnmarshallerHandler
UseCaseDescriptor
User
User
UserAdapter
ValidationContext
ValidationEventHandler
XSAnnotation
XSAttGroupDecl
XSAttributeDecl
XSComplexType
XSComponent
XSContentType
XSDeclaration
XSElementDecl
XSIdentityConstraint
XSListSimpleType
XSModelGroup
XSModelGroupDecl
XSNotation
XSParticle
XSSchema
XSSchemaSet
XSSimpleType
XSTerm
XSType
XSUnionSimpleType
XSVariety
XSXPath
XmlString