Jump to

• Request
• Response

Get a Model Action

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/_actions/{actionVarName}

Use this endpoint to retrieve the specified Model action.

Request

Supported Media Types

• application/json

Path Parameters

• actionVarName(required): string
  Variable Name of the action.
• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'
• 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

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Configuration Actions

Type: object

Title: Configuration Actions

Show Source

• 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

  Variable Name of the Config Action

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Description of the Config Action",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Config Action",
            "title":"Action Name"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Status of Config Action",
            "title":"Config Action Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "userAddedFirstName":{
            "type":"string",
            "description":"First Name of the user who created the record",
            "title":"User Added First Name"
        },
        "userAddedLastName":{
            "type":"string",
            "description":"Last Name of the user who created the record",
            "title":"User Added  Last Name"
        },
        "userModifiedFirstName":{
            "type":"string",
            "description":"First Name of the user who modified the record",
            "title":"User Modified  First Name"
        },
        "userModifiedLastName":{
            "type":"string",
            "description":"Last Name of the user who modified the record",
            "title":"User Modified  Last Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Config Action",
            "title":"Variable Name"
        }
    },
    "title":"Configuration Actions"
}

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.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Status of Config Action",
    "title":"Config Action Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top