Jump to

• Request
• Response
• Examples

Load Array Set Data

post

/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_set{arraySetVarName}/actions/_loadData

This action reads the configuration data from a particular array set. This endpoint will not run the rules but rather loads that configuration data of the array set. The cache instance ID is used as the input parameter in the request body.

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_loadDataRequest

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.

{
    "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"
        }
    }
}

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
• 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.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• fields: array fields
  Array of field names that you wanted returned in a request.
• 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.

{
    "type":"object",
    "properties":{
        "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."
        },
        "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"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions 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"
            }
        }
    },
    "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 : 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 : 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 : 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_loadDataResponse

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

Examples

The following example reads the configuration data from a particular array set and loads that configuration data of the array set by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/configvision.servers.ultraPowerSolutionPackage/_setapplicationSoftware/actions/_loadData

Request Body Sample

{
	"cacheInstanceId": "ZGQn3ciig5QBSvvvzZnin1IpAEUyC0wTv122guTBLnzGWnjgG6ekKPa7JvNrQubs3",
	"criteria": {
		"state": true,
		"fields": ["arrayTextField1"]
	}
}
         

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
	"_state": {
		"insertable": true,
		"sortable": false,
		"deletable": true,
		"defaultRowState": {
			"updatable": true,
			"hasError": false,
			"messages": [],
			"attributes": {
				"arrayTextField1": {
					"updatable": true,
					"hasError": false,
					"hasWarning": false,
					"messages": [],
					"visible": true,
					"hasConstraintViolation": false
				}
			}
		},
		"actions": {
			"_delete": {
				"enabled": true,
				"visible": true
			},
			"_add": {
				"enabled": true,
				"visible": true
			}
		},
		"attributes": {
			"arrayTextField1": {
				"visible": true
			}
		}
	},
	"items": [{
			"index": 0,
			"_rowKey": "6d5eb9ef-393c-43aa-9528-925489f8767d",
			"arrayTextField1": "test0",
			"_state": {
				"hasError": false,
				"messages": []
			}
		}, {
			"index": 1,
			"_rowKey": "d8da0d00-92d3-48bb-af02-1bf72c80fd81",
			"arrayTextField1": "",
			"_state": {
				"hasError": false,
				"messages": []
			}
		}, {
			"index": 2,
			"_rowKey": "bb3102d3-a83e-47ef-a38d-0abe9f31508e",
			"arrayTextField1": "",
			"_state": {
				"hasError": false,
				"messages": []
			}
		}
	],
	"cacheInstanceId": "ZGQn3ciig5QBSvvvzZnin1IpAEUyC0wTv122guTBLnzGWnjgG6ekKPa7JvNrQubs3"
}

Back to Top