> NSI_API_V4_TPES

        Handle resource of type nsi_api_v4_tpes

OPTIONS (= is mandatory):

- active
        (Optional) The active state of the resource
        Used by `state=['get']'
        (Choices: false, true)[Default: (null)]
        type: str

- bookingData.lockout
        (Optional)  Flag that enables/disables a link from having
        additional tunnel BW being consumed
        Used by `state=['get']'
        (Choices: false, true)[Default: (null)]
        type: str

- concrete
        (Optional) Id of the concrete tpe
        Used by `state=['get']'
        [Default: (null)]
        type: str

- content
        (Optional) The TPE content level
        Used by `state=['get']'
        (Choices: detail, summary)[Default: (null)]
        type: str

- data
        Validate attributes are:
         - `attributes' (dict):
         - `id' (str): The unique identifier for the TPE resource
         - `meta' (dict): A metadata object that contains non-standard
        meta information
         - `relationships' (dict):
         - `type' (str): The TPE resource type
        Used by `state=['post']'
        [Default: (null)]
        type: dict

- equipmentId
        (Optional) Equipment identifier. In case of usage with limit
        parameter, paging will be enabled.
        Used by `state=['get']'
        [Default: (null)]
        type: str

- fields
        (Optional) List of comma separated fields to be included in
        the response. Fields require full path (i.e.
        data.attributes.field)
        Used by `state=['get']'
        [Default: (null)]
        type: str

- gneSubnetName
        (Optional) GNE Subnet name of the TPE
        Used by `state=['get']'
        [Default: (null)]
        type: str

- id
        (Optional) Comma separated list of TPE identifiers to retrieve
        Used by `state=['get']'
        [Default: (null)]
        type: str

- identifierKey
        (Optional) The comma separated identifier key set
        Used by `state=['get']'
        [Default: (null)]
        type: list

- identifierValue
        (Optional) The comma separated identifier value set
        Used by `state=['get']'
        [Default: (null)]
        type: list

- include
        (Optional) List of comma separated resources to be side-
        loaded. The allowed values are: expectations, concrete,
        networkConstructs
        Used by `state=['get']'
        [Default: (null)]
        type: str

- included
        Referenced sub-resources
        Used by `state=['post']'
        [Default: (null)]
        type: list

- limit
        The size of a returned page
        Used by `state=['get']'
        [Default: (null)]
        type: str

- location
        (Optional) TPE location delimited by dashes
        Used by `state=['get']'
        [Default: (null)]
        type: str

- locationFormat
        (Optional) Format for the given location; when not given,
        assume location is [[shelf-]slot-]port
        Used by `state=['get']'
        [Default: (null)]
        type: str

- meta
        A metadata object that contains non-standard meta information
        Validate attributes are:
         - `absoluteTotal' (int): The unfiltered total number of
        entities in the data
         - `aggregations' (list): The aggregated data based on a
        requested aggregation name and criteria
         - `filtered' (bool): Flags whether the current object is
        filtered using `fields` query param or not
         - `missingReferenceIds' (list): The list of missing resource
        IDs
         - `missingReferences' (bool): boolean detailing if the GET
        FRE tree has any missing references
         - `total' (int): The total number of entities in the data
        Used by `state=['post']'
        [Default: (null)]
        type: dict

- metaDataFields
        (Optional) List of meta data to be included. The allowed
        values are: stackDirection, layerRate, state, cardType,
        structureType, structureSubType, resourceState
        Used by `state=['get']'
        [Default: (null)]
        type: str

- modelType
        (Optional) modelType parameter used to filter results
        Used by `state=['get']'
        [Default: (null)]
        type: str

- namedQuery
        (Optional) Comma-separated named query id list; The allowed
        values are: portsL2AvailableAll, portsL2ApplicableEPLUni,
        portsL2ApplicableEVPLUni, portsL2ApplicableEnni,
        portsL2ApplicableEPLUniWithMcLag,
        portsL2ApplicableEVPLUniWithMcLag,
        portsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll,
        portsTDMCEApplicableAll
        Used by `state=['get']'
        [Default: (null)]
        type: str

- networkConstruct.id
        (Optional) Network Construct identifier
        Used by `state=['get']'
        [Default: (null)]
        type: str

- offset
        Offset for the second page
        Used by `state=['get']'
        [Default: (null)]
        type: str

- resourceState
        (Optional) List of networkConstruct planning states. By
        default, if no value for this parameter is specified, root and
        unknown states are filtered out. The allowed values are: root,
        planned, discovered, plannedAndDiscovered, unknown
        Used by `state=['get']'
        [Default: (null)]
        type: str

- searchFields
        (Optional) List of comma separated fields to search on. If
        none are specified, all supported fields are implied. Fields
        require full path (e.g. data.attributes.name)
        Used by `state=['get']'
        [Default: (null)]
        type: str

- searchText
        (Optional) The searchable text
        Used by `state=['get']'
        [Default: (null)]
        type: str

- sortBy
        (Optional) List of comma separated fields by which to sort the
        result. Fields require full path (i.e. data.attributes.field).
        A dash or negative sign before a field indicates descending
        order; by default ascending order is used
        Used by `state=['get']'
        [Default: (null)]
        type: str

- state
        (Choices: get, post)[Default: (null)]
        type: str

- structureType
        (Optional) Comma separated list of TPE structure types
        Used by `state=['get']'
        [Default: (null)]
        type: str

- tpeExpectations.equipmentIntent.id
        (Optional) The equipment intent Id
        Used by `state=['get']'
        [Default: (null)]
        type: str

- tpeExpectations.serviceIntent.id
        (Optional) The service intent Id
        Used by `state=['get']'
        [Default: (null)]
        type: str


REQUIREMENTS:  python >= 3.6
