ApiObject Data Type

Java class for ApiObject complex type.

Subtypes
MyApiObject
Properties
name data type constraints description
apiId string regex: ^[^_]*$, max size: 100, min size: 0 Api id.
apiDisplayName string max size: 100, min size: 1 Api display name.
apiName string required, regex: ^\s*/?(?!(management$))(?!(management/))(?!(portal$))(?!(portal/))(?!(prm_pm_rest$))(?!prm_pm_rest/)(?!(daf-network)$)(?!daf-network/)([\.a-zA-Z0-9_-]+/?)+$, max size: 100, min size: 1
apiVersion string regex: [0-9a-zA-Z_\.-]*, max size: 50, min size: 0 Api version. Can be empty.
status ApiStatus  
accessUrl string   Api access url.
apiInterfaces array of ApiInterface   List of ApiInterfaces.
contractname string   Contract name.
contractversion string   Contract version.
description string max size: 1000, min size: 1 Description.
facade string   Facade.
serviceType string required Service type. It is required.
protocol string   Protocol.
privilege number   Privilege.
link string   Link.
accessType AccessType   AccessType.
authType AuthType   AuthType value.
authToken string   Access token.
groups array of string   List of groups.
wadlFiles array of WadlFile   Optional list of wadl files for south bound.
northBoundWadlFiles array of WadlFile   Optional list of wadl files for north bound.
direction Direction   Direction.
networkAuthorizationURI string   Network authorization uri.
networkTokenURI string   Network token uri.
networkClientRedirectURI string   Network client redirect uri.
icon string   Icon.
csServiceType string   Cs service type.
csOption CsOption   CsOption.
networkProxy string   Network proxy.
apiAuthTypes array of ApiAuthType   List of ApiAuthType.
Properties inherited from TaskObject
notificationId string  

Example

{
  "apiObject" : {
    "apiId" : "...",
    "apiDisplayName" : "...",
    "apiName" : "...",
    "apiVersion" : "...",
    "status" : "CREATED",
    "accessUrl" : "...",
    "apiInterfaces" : [ {
      "name" : "...",
      "apiMethods" : [ {
        "name" : "...",
        "changeCode" : "...",
        "displayName" : "...",
        "parameterSettings" : [ {
        }, {
        } ],
        "settlementCode" : "...",
        "spslas" : [ {
        }, {
        } ],
        "path" : "...",
        "httpVerb" : "...",
        "servicePath" : "...",
        "serviceHttpVerb" : "...",
        "expose" : true
      }, {
        "name" : "...",
        "changeCode" : "...",
        "displayName" : "...",
        "parameterSettings" : [ {
        }, {
        } ],
        "settlementCode" : "...",
        "spslas" : [ {
        }, {
        } ],
        "path" : "...",
        "httpVerb" : "...",
        "servicePath" : "...",
        "serviceHttpVerb" : "...",
        "expose" : true
      } ],
      "displayName" : "...",
      "fileLocation" : "...",
      "notificationId" : "..."
    }, {
      "name" : "...",
      "apiMethods" : [ {
        "name" : "...",
        "changeCode" : "...",
        "displayName" : "...",
        "parameterSettings" : [ {
        }, {
        } ],
        "settlementCode" : "...",
        "spslas" : [ {
        }, {
        } ],
        "path" : "...",
        "httpVerb" : "...",
        "servicePath" : "...",
        "serviceHttpVerb" : "...",
        "expose" : true
      }, {
        "name" : "...",
        "changeCode" : "...",
        "displayName" : "...",
        "parameterSettings" : [ {
        }, {
        } ],
        "settlementCode" : "...",
        "spslas" : [ {
        }, {
        } ],
        "path" : "...",
        "httpVerb" : "...",
        "servicePath" : "...",
        "serviceHttpVerb" : "...",
        "expose" : true
      } ],
      "displayName" : "...",
      "fileLocation" : "...",
      "notificationId" : "..."
    } ],
    "contractname" : "...",
    "contractversion" : "...",
    "description" : "...",
    "facade" : "...",
    "serviceType" : "...",
    "protocol" : "...",
    "privilege" : 12345,
    "link" : "...",
    "accessType" : "NONE",
    "authType" : "NONE",
    "authToken" : "...",
    "groups" : [ "...", "..." ],
    "wadlFiles" : [ {
      "fileName" : "...",
      "fileContent" : "..."
    }, {
      "fileName" : "...",
      "fileContent" : "..."
    } ],
    "northBoundWadlFiles" : [ {
      "fileName" : "...",
      "fileContent" : "..."
    }, {
      "fileName" : "...",
      "fileContent" : "..."
    } ],
    "direction" : "AOMT",
    "networkAuthorizationURI" : "...",
    "networkTokenURI" : "...",
    "networkClientRedirectURI" : "...",
    "icon" : "...",
    "csServiceType" : "...",
    "csOption" : "OCSG",
    "networkProxy" : "...",
    "apiAuthTypes" : [ "TEXT", "TEXT" ],
    "notificationId" : "..."
  }
}