ApiInterface Data Type

Java class for ApiInterface complex type.

Properties
name data type constraints description
name string required Api name. It is required.
apiMethods array of ApiMethod   List of api methods.
displayName string   Api display name.
fileLocation string   File location.
Properties inherited from TaskObject
notificationId string  

Example

{
  "apiInterface" : {
    "name" : "...",
    "apiMethods" : [ {
      "name" : "...",
      "changeCode" : "...",
      "displayName" : "...",
      "parameterSettings" : [ {
        "description" : "...",
        "displayInPortal" : true,
        "key" : "..."
      }, {
        "description" : "...",
        "displayInPortal" : true,
        "key" : "..."
      } ],
      "settlementCode" : "...",
      "spslas" : [ {
        "serviceTypeContract" : [ {
        }, {
        } ],
        "serviceContract" : [ {
        }, {
        } ],
        "serviceProviderGroupID" : "...",
        "composedServiceContract" : [ {
        }, {
        } ],
        "notificationId" : "..."
      }, {
        "serviceTypeContract" : [ {
        }, {
        } ],
        "serviceContract" : [ {
        }, {
        } ],
        "serviceProviderGroupID" : "...",
        "composedServiceContract" : [ {
        }, {
        } ],
        "notificationId" : "..."
      } ],
      "path" : "...",
      "httpVerb" : "...",
      "servicePath" : "...",
      "serviceHttpVerb" : "...",
      "expose" : true
    }, {
      "name" : "...",
      "changeCode" : "...",
      "displayName" : "...",
      "parameterSettings" : [ {
        "description" : "...",
        "displayInPortal" : true,
        "key" : "..."
      }, {
        "description" : "...",
        "displayInPortal" : true,
        "key" : "..."
      } ],
      "settlementCode" : "...",
      "spslas" : [ {
        "serviceTypeContract" : [ {
        }, {
        } ],
        "serviceContract" : [ {
        }, {
        } ],
        "serviceProviderGroupID" : "...",
        "composedServiceContract" : [ {
        }, {
        } ],
        "notificationId" : "..."
      }, {
        "serviceTypeContract" : [ {
        }, {
        } ],
        "serviceContract" : [ {
        }, {
        } ],
        "serviceProviderGroupID" : "...",
        "composedServiceContract" : [ {
        }, {
        } ],
        "notificationId" : "..."
      } ],
      "path" : "...",
      "httpVerb" : "...",
      "servicePath" : "...",
      "serviceHttpVerb" : "...",
      "expose" : true
    } ],
    "displayName" : "...",
    "fileLocation" : "...",
    "notificationId" : "..."
  }
}