ApiMethod Data Type

Java class for ApiMethod complex type.

Properties
name data type constraints description
name string required Name for api method. Required.
changeCode string   Change code.
displayName string   Api method display name.
parameterSettings array of ParamSetting   Settings for parameter.
settlementCode string   Settlement code.
spslas array of SpSla   Sp SLA list.
path string   North bound path.
httpVerb string   Http verb for api method.
servicePath string   South bound path.
serviceHttpVerb string   Api display name.
expose boolean   Expose.

Example

{
  "apiMethod" : {
    "name" : "...",
    "changeCode" : "...",
    "displayName" : "...",
    "parameterSettings" : [ {
      "description" : "...",
      "displayInPortal" : true,
      "key" : "..."
    }, {
      "description" : "...",
      "displayInPortal" : true,
      "key" : "..."
    } ],
    "settlementCode" : "...",
    "spslas" : [ {
      "serviceTypeContract" : [ {
        "quota" : {
        },
        "rate" : {
        },
        "serviceTypeName" : "...",
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "quota" : {
        },
        "rate" : {
        },
        "serviceTypeName" : "...",
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "serviceContract" : [ {
        "contract" : {
        },
        "interfaceName" : "...",
        "overrides" : {
        },
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "contract" : {
        },
        "interfaceName" : "...",
        "overrides" : {
        },
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "serviceProviderGroupID" : "...",
      "composedServiceContract" : [ {
        "contractTypeByServiceTypeAndInterfaceName" : "...",
        "quota" : {
        },
        "rate" : {
        },
        "serviceList" : [ {
        }, {
        } ],
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "contractTypeByServiceTypeAndInterfaceName" : "...",
        "quota" : {
        },
        "rate" : {
        },
        "serviceList" : [ {
        }, {
        } ],
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "notificationId" : "..."
    }, {
      "serviceTypeContract" : [ {
        "quota" : {
        },
        "rate" : {
        },
        "serviceTypeName" : "...",
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "quota" : {
        },
        "rate" : {
        },
        "serviceTypeName" : "...",
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "serviceContract" : [ {
        "contract" : {
        },
        "interfaceName" : "...",
        "overrides" : {
        },
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "contract" : {
        },
        "interfaceName" : "...",
        "overrides" : {
        },
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "serviceProviderGroupID" : "...",
      "composedServiceContract" : [ {
        "contractTypeByServiceTypeAndInterfaceName" : "...",
        "quota" : {
        },
        "rate" : {
        },
        "serviceList" : [ {
        }, {
        } ],
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      }, {
        "contractTypeByServiceTypeAndInterfaceName" : "...",
        "quota" : {
        },
        "rate" : {
        },
        "serviceList" : [ {
        }, {
        } ],
        "contractTypeFor" : "...",
        "contractTypeName" : "...",
        "effectiveFrom" : 12345,
        "effectiveTo" : 12345
      } ],
      "notificationId" : "..."
    } ],
    "path" : "...",
    "httpVerb" : "...",
    "servicePath" : "...",
    "serviceHttpVerb" : "...",
    "expose" : true
  }
}