Jump to

• Request
• Response

Delete Row from an Array

post

/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_delete

This action deletes a specified index or row in a payload from the given Array set.

Request

Supported Media Types

• application/json

Path Parameters

• arraySetVarName(required): string
  The variable name of the array set
• modelVarName(required): string
  The variable name of a Model
• prodFamVarName(required): string
  The variable name of a Product Family
• prodLineVarName(required): string
  The variable name of a Product Line

Body ()

Root Schema : arraySetVarName_deleteRequest

Type: object

Show Source

• cacheInstanceId(required): string
  Title: Cache Instance Id

  The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• removeIndex: integer
  Title: Remove Index

  Index which has to be removed from the array set.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "removeIndex":{
            "type":"integer",
            "description":"Index which has to be removed from the array set.",
            "title":"Remove Index"
        }
    }
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• enableHierarchy: boolean
  Parameter value should be true to execute hierarchy search and sort. Default value is false.
• excludeFieldTypes: array excludeFieldTypes
  Array of field names that you want to exclude in the response.
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomainCriteria: array expandedDomainCriteria
  Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• expandNodes: boolean
  Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
• fields: array fields
  Array of field names that you wanted returned in a request.
• groups: array groups
  Array of group names, whose state is requested in the state object response.
• limit: integer
  Positive integer value that specifies the maximum number of items returned by the server.
• nodesExceptionList: array nodesExceptionList
  Array of document_number, recording the nodes that violate current expandNodes flag
• offset: integer
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated."
        },
        "q":{
            "type":"string",
            "description":"Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "limit":{
            "type":"integer",
            "description":"Positive integer value that specifies the maximum number of items returned by the server."
        },
        "offset":{
            "type":"integer",
            "description":"Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection."
        },
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
            "items":{
                "type":"string"
            }
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "excludeFieldTypes":{
            "type":"array",
            "description":"Array of field names that you want to exclude in the response.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "groups":{
            "type":"array",
            "description":"Array of group names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        },
        "enableHierarchy":{
            "type":"boolean",
            "description":"Parameter value should be true to execute hierarchy search and sort. Default value is false."
        },
        "expandNodes":{
            "type":"boolean",
            "description":"Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true."
        },
        "nodesExceptionList":{
            "type":"array",
            "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
            "items":{
                "type":"string"
            }
        },
        "expandedDomainCriteria":{
            "type":"array",
            "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

Nested Schema : excludeFieldTypes

Type: array

Array of field names that you want to exclude in the response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you want to exclude in the response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expand

Type: array

Array of child resource names that you want to expand so that the contents return with the parent in the same request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomainCriteria

Type: array

Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : groups

Type: array

Array of group names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of group names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodesExceptionList

Type: array

Array of document_number, recording the nodes that violate current expandNodes flag

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderBy

Type: array

Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : arraySetVarName_deleteResponse

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
• count: integer
  Title: Count

  Specifies that the total count of records should be included in the response when doing pagination.
• hasMore: boolean
  Title: Has More

  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  Title: Limit

  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  Title: Offset

  The offset of the page. By default, offset is 0, which means first page will be returned.
• totalResults: integer
  Title: Total Results

  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results"
        },
        "offset":{
            "type":"integer",
            "description":"The offset of the page. By default, offset is 0, which means first page will be returned.",
            "title":"Offset"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "limit":{
            "type":"integer",
            "description":"The requested page size, which limits the number of elements the collection should max return.",
            "title":"Limit"
        },
        "count":{
            "type":"integer",
            "description":"Specifies that the total count of records should be included in the response when doing pagination.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page.",
            "title":"Has More"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/arraySetVarName"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Array Set Name
  Title: Array Set Name

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/arraySetVarName"
    }
}

Nested Schema : Array Set Name

Type: object

Title: Array Set Name

Show Source

• _index: integer
  Title: Index

  Index of the element in the array set.
• _rowKey: string
  Title: RowKey

  Key of the element in the array set.

{
    "type":"object",
    "properties":{
        "_index":{
            "type":"integer",
            "description":"Index of the element in the array set.",
            "title":"Index"
        },
        "_rowKey":{
            "type":"string",
            "description":"Key of the element in the array set.",
            "title":"RowKey"
        }
    },
    "title":"Array Set Name",
    "description":""
}

Back to Top