serviceMethodDatatypes.json

========= SERVICE ========
Array
(
    [0] => stdClass Object
        (
            [title] => SoftLayer_Network_SecurityGroup
            [type] => service
            [body] => The Security Group service provides a common interface to interact with an account's security groups, their rules, and virtual guest instances associated with the groups. A security group contains a set of IP filter rules that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance. The rules that you add to a security group are known as [[SoftLayer_Network_SecurityGroup_Rule (type)|security group rules]]. Security groups can be assigned to one or more virtual servers by attaching virtual guest network components through [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)|bindings]].

Additional information can be found in Bluemix Docs and SoftLayer API Examples https://console.bluemix.net/docs/infrastructure/security-groups/sg_index.html https://softlayer.github.io/classes/softlayer_network_securitygroup/
            [externalLinks] => Array
                (
                )

            [associatedMethods] => Array
                (
                )

            [seeAlso] => Array
                (
                )

            [category] => Network
            [methods] => Array
                (
                    [0] => stdClass Object
                        (
                            [title] => addRules
                            [type] => method
                            [shortDescription] => Add new rules to a security group.
                            [body] => Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Request
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => ruleTemplates
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of rule objects you want to create
                                            [sldnType] => SoftLayer_Network_SecurityGroup_Rule
                                            [isArray] => an array of
                                        )

                                )

                        )

                    [1] => stdClass Object
                        (
                            [title] => attachNetworkComponents
                            [type] => method
                            [shortDescription] => Attach network components to a security group by creating a network component binding.
                            [body] => Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Request
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => networkComponentIds
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of SoftLayer_Virtual_Guest_Network_Component IDs for components you want to attach
                                            [sldnType] => array of integers
                                            [isArray] =>
                                        )

                                )

                        )

                    [2] => stdClass Object
                        (
                            [title] => createObject
                            [type] => method
                            [shortDescription] => Create a new security group.
                            [body] => Create a new security group.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => templateObject
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => The SoftLayer_Network_SecurityGroup object that you wish to create.
                                            [sldnType] => SoftLayer_Network_SecurityGroup
                                            [isArray] =>
                                        )

                                )

                        )

                    [3] => stdClass Object
                        (
                            [title] => createObjects
                            [type] => method
                            [shortDescription] => Create new security groups.
                            [body] => Create new security groups.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup
                            [isArray] => 1
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => templateObjects
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of SoftLayer_Network_SecurityGroup objects that you wish to create.
                                            [sldnType] => SoftLayer_Network_SecurityGroup
                                            [isArray] => an array of
                                        )

                                )

                        )

                    [4] => stdClass Object
                        (
                            [title] => deleteObject
                            [type] => method
                            [shortDescription] => Delete a security group.
                            [body] => Delete a security group for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => boolean
                            [isArray] =>
                            [parameters] => Array
                                (
                                )

                        )

                    [5] => stdClass Object
                        (
                            [title] => deleteObjects
                            [type] => method
                            [shortDescription] => Delete security groups.
                            [body] => Delete security groups for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => boolean
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => templateObjects
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of skeleton SoftLayer_Network_SecurityGroup objects that you wish to delete. Each object in the array must have at least their id properties defined.
                                            [sldnType] => SoftLayer_Network_SecurityGroup
                                            [isArray] => an array of
                                        )

                                )

                        )

                    [6] => stdClass Object
                        (
                            [title] => detachNetworkComponents
                            [type] => method
                            [shortDescription] => Detach network components from a security group by deleting its network component binding.
                            [body] => Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]].
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Request
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => networkComponentIds
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of SoftLayer_Virtual_Guest_Network_Component IDs for components you want to detach
                                            [sldnType] => array of integers
                                            [isArray] =>
                                        )

                                )

                        )

                    [7] => stdClass Object
                        (
                            [title] => editObject
                            [type] => method
                            [shortDescription] => Edit a security group.
                            [body] => Edit a security group.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => boolean
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => templateObject
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => A skeleton SoftLayer_Network_SecurityGroup object with only the properties defined that you wish to change. Unchanged properties are left alone.
                                            [sldnType] => SoftLayer_Network_SecurityGroup
                                            [isArray] =>
                                        )

                                )

                        )

                    [8] => stdClass Object
                        (
                            [title] => editObjects
                            [type] => method
                            [shortDescription] => Edit security groups.
                            [body] => Edit security groups.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => boolean
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => templateObjects
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of skeleton SoftLayer_Network_SecurityGroup objects with only the properties defined that you wish to change. Unchanged properties are left alone.
                                            [sldnType] => SoftLayer_Network_SecurityGroup
                                            [isArray] => an array of
                                        )

                                )

                        )

                    [9] => stdClass Object
                        (
                            [title] => editRules
                            [type] => method
                            [shortDescription] => Edit rules that belong to a security group.
                            [body] => Edit rules that belong to the security group. An array of skeleton [[SoftLayer_Network_SecurityGroup_Rule]] objects must be sent in with only the properties defined that you want to change. To edit a property to null, send in -1 for integer properties and "" for string properties. Unchanged properties are left alone.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Request
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => rules
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of rule objects
                                            [sldnType] => SoftLayer_Network_SecurityGroup_Rule
                                            [isArray] => an array of
                                        )

                                )

                        )

                    [10] => stdClass Object
                        (
                            [title] => getAccount
                            [type] => method
                            [shortDescription] => Retrieve the account this security group belongs to.
                            [body] => Retrieve the account this security group belongs to.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [2] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupInitParameters
                                    [1] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Account
                            [isArray] =>
                            [parameters] => Array
                                (
                                )

                        )

                    [11] => stdClass Object
                        (
                            [title] => getAllObjects
                            [type] => method
                            [shortDescription] => Get all security groups.
                            [body] =>
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_ObjectMask
                                    [2] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [3] => resultLimit
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [12] => stdClass Object
                        (
                            [title] => getLimits
                            [type] => method
                            [shortDescription] => List the current security group limits
                            [body] => List the current security group limits
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Container_Network_SecurityGroup_Limit
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [13] => stdClass Object
                        (
                            [title] => getNetworkComponentBindings
                            [type] => method
                            [shortDescription] => Retrieve the network component bindings for this security group.
                            [body] => Retrieve the network component bindings for this security group.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [2] => resultLimit
                                    [3] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupInitParameters
                                    [1] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [14] => stdClass Object
                        (
                            [title] => getObject
                            [type] => method
                            [shortDescription] => Retrieve a SoftLayer_Network_SecurityGroup record.
                            [body] =>
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [2] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupInitParameters
                                    [1] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup
                            [isArray] =>
                            [parameters] => Array
                                (
                                )

                        )

                    [15] => stdClass Object
                        (
                            [title] => getOrderBindings
                            [type] => method
                            [shortDescription] => Retrieve the order bindings for this security group
                            [body] => Retrieve the order bindings for this security group
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [2] => resultLimit
                                    [3] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupInitParameters
                                    [1] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_OrderBinding
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [16] => stdClass Object
                        (
                            [title] => getRules
                            [type] => method
                            [shortDescription] => Retrieve the rules for this security group.
                            [body] => Retrieve the rules for this security group.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_Network_SecurityGroupObjectFilter
                                    [2] => resultLimit
                                    [3] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupInitParameters
                                    [1] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Rule
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [17] => stdClass Object
                        (
                            [title] => getSupportedDataCenters
                            [type] => method
                            [shortDescription] => List the data centers that currently support the use of security groups.
                            [body] => List the data centers that currently support the use of security groups.
                            [optionalHeaders] => Array
                                (
                                    [0] => SoftLayer_Network_SecurityGroupObjectMask
                                    [1] => SoftLayer_ObjectMask
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Location
                            [isArray] => 1
                            [parameters] => Array
                                (
                                )

                        )

                    [18] => stdClass Object
                        (
                            [title] => removeRules
                            [type] => method
                            [shortDescription] => Remove rules from a security group.
                            [body] => Remove rules from a security group.
                            [optionalHeaders] => Array
                                (
                                )

                            [requiredHeaders] => Array
                                (
                                    [0] => authenticate
                                    [1] => SoftLayer_Network_SecurityGroupInitParameters
                                )

                            [externalLinks] => Array
                                (
                                )

                            [associatedMethods] => Array
                                (
                                )

                            [errorHandling] => Array
                                (
                                )

                            [created] => 1519079410
                            [changed] => 1519079410
                            [returnValue] => SoftLayer_Network_SecurityGroup_Request
                            [isArray] =>
                            [parameters] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [title] => ruleIds
                                            [type] => parameter
                                            [defaultValue] =>
                                            [body] => An array of SoftLayer_Network_SecurityGroup_Rule IDs for rules you want to delete
                                            [sldnType] => array of integers
                                            [isArray] =>
                                        )

                                )

                        )

                )

        )

)
========= DATATYPE ========
Array
(
    [0] => stdClass Object
        (
            [title] => SoftLayer_Network_SecurityGroup
            [type] => datatype
            [body] => The SoftLayer_Network_SecurityGroup data type contains general information for a single security group. A security group contains a set of IP filter [[SoftLayer_Network_SecurityGroup_Rule (type)|rules]] that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance and a set of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)|bindings]] to associate virtual guest network components with the security group.
            [externalLinks] => Array
                (
                )

            [associatedMethods] => Array
                (
                )

            [seeAlso] => Array
                (
                )

            [category] => Network
            [localProperties] => Array
                (
                    [0] => stdClass Object
                        (
                            [title] => createDate
                            [body] => The date a security group was created.
                            [type] => local_property
                            [requiredForCreate] =>
                            [classType] => dateTime
                            [isArray] =>
                        )

                    [1] => stdClass Object
                        (
                            [title] => description
                            [body] => The (optional) description for a security group.
                            [type] => local_property
                            [requiredForCreate] =>
                            [classType] => string
                            [isArray] =>
                        )

                    [2] => stdClass Object
                        (
                            [title] => id
                            [body] => The unique ID for a security group.
                            [type] => local_property
                            [requiredForCreate] =>
                            [classType] => integer
                            [isArray] =>
                        )

                    [3] => stdClass Object
                        (
                            [title] => modifyDate
                            [body] => The date a security group was last modified.
                            [type] => local_property
                            [requiredForCreate] =>
                            [classType] => dateTime
                            [isArray] =>
                        )

                    [4] => stdClass Object
                        (
                            [title] => name
                            [body] => The (optional) name for a security group.
                            [type] => local_property
                            [requiredForCreate] =>
                            [classType] => string
                            [isArray] =>
                        )

                )

            [relationalProperties] => Array
                (
                    [0] => stdClass Object
                        (
                            [title] => account
                            [body] => The account this security group belongs to.
                            [type] => relational_property
                            [classType] => SoftLayer_Account
                            [isArray] =>
                        )

                    [1] => stdClass Object
                        (
                            [title] => networkComponentBindings
                            [body] => The network component bindings for this security group.
                            [type] => relational_property
                            [classType] => SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding
                            [isArray] => An array of
                        )

                    [2] => stdClass Object
                        (
                            [title] => orderBindings
                            [body] => The order bindings for this security group
                            [type] => relational_property
                            [classType] => SoftLayer_Network_SecurityGroup_OrderBinding
                            [isArray] => An array of
                        )

                    [3] => stdClass Object
                        (
                            [title] => rules
                            [body] => The rules for this security group.
                            [type] => relational_property
                            [classType] => SoftLayer_Network_SecurityGroup_Rule
                            [isArray] => An array of
                        )

                )

            [countProperties] => Array
                (
                    [0] => stdClass Object
                        (
                            [title] => networkComponentBindingCount
                            [body] => A count of the network component bindings for this security group.
                            [type] => count_property
                            [classType] => unsignedLong
                        )

                    [1] => stdClass Object
                        (
                            [title] => orderBindingCount
                            [body] => A count of the order bindings for this security group
                            [type] => count_property
                            [classType] => unsignedLong
                        )

                    [2] => stdClass Object
                        (
                            [title] => ruleCount
                            [body] => A count of the rules for this security group.
                            [type] => count_property
                            [classType] => unsignedLong
                        )

                )

        )

)