Get List of Model Actions
get
/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions
Use this endpoint to retrieve a list of all Model Actions.
Request
Supported Media Types
- application/json
Path Parameters
-
modelVarName(required): string
Variable Name of the Model.
-
prodFamVarName(required): string
Variable Name of the Product Family.
-
prodLineVarName(required): string
Variable Name of the Product Line
-
varName(required): string
Variable Name of All Product Families '_allProductFamilies'
Query Parameters
-
expand: string
Allows expansion of relationships.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : configActions-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
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.
Nested Schema : Actions
Type:
object
Title:
Show Source
Actions
-
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
description:
string
Title:
Description
Description of the Config Action -
id:
integer
Title:
Id
Primary Key of the resource -
label:
string
Title:
Action Name
Name of the Config Action -
refType:
object Reference Type
Title:
Reference Type
Type of the Reference -
status:
object Config Action Status
Title:
Config Action Status
Status of Config Action -
userAddedFirstName:
string
Title:
User Added First Name
First Name of the user who created the record -
userAddedLastName:
string
Title:
User Added Last Name
Last Name of the user who created the record -
userModifiedFirstName:
string
Title:
User Modified First Name
First Name of the user who modified the record -
userModifiedLastName:
string
Title:
User Modified Last Name
Last Name of the user who modified the record -
variableName:
string
Title:
Variable Name of All Product Families '_allProductFamilies'
Variable Name of the action.
Nested Schema : Reference Type
Type:
object
Title:
Reference Type
Type of the Reference
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Config Action Status
Type:
object
Title:
Config Action Status
Status of Config Action
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.