Jump to

• Request
• Response

Get all product group usages

get

/crmRestApi/resources/11.13.18.05/productGroupUsages

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a product group usage with the specified primary key.
    Finder Variables:
    • UsageCode; string; The bind variable criteria to filter usages using usage code. This criteria is mandatory to use primary key finder.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowDupContentFlag; boolean; Indicates that duplicate content is allowed.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
  • UsageCode; string; The usage code of the product group.
  • UsageDescText; string; The usage description text of the product group usage.
  • UsageName; string; The name of the product group usage.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productGroupUsages

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/productGroupUsages-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productGroupUsages-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/productGroupUsages-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productGroupUsages-item-response

Type: object

Show Source

• AllowDupContentFlag: boolean
  Title: Allow Duplicate Content

  Maximum Length: 1

  Default Value: true

  Indicates that duplicate content is allowed.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductGroupUsageEngine: array Product Group Usage Functions
  Title: Product Group Usage Functions

  The product group usage engines resource is used to view the usage engines of the product group.
• ProductGroupUsageModeSetup: array Product Group Usage Modes
  Title: Product Group Usage Modes

  The product group usage modes resource is used to view the usage mode of the product group.
• ProductGroupUsagePreferenceSetup: array Product Group Usage Preferences
  Title: Product Group Usage Preferences

  The product group usage preferences resource is used to view the usage preferences of the product group.
• ProductGroupUsageRootProdGrpSetup: array Product Group Usage Roots
  Title: Product Group Usage Roots

  The product group usage roots resource is used to view the usage roots of the product group.
• UsageCode: string
  Title: Usage Code

  Maximum Length: 30

  The usage code of the product group.
• UsageDescText: string
  Title: Description

  Maximum Length: 250

  The usage description text of the product group usage.
• UsageName: string
  Title: Usage

  Maximum Length: 100

  The name of the product group usage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageDescText":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"The usage description text of the product group usage.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "title":"Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupUsageModeSetup":{
            "title":"Product Group Usage Modes",
            "type":"array",
            "description":"The product group usage modes resource is used to view the usage mode of the product group.",
            "items":{
                "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageModeSetup-item-response"
            }
        },
        "AllowDupContentFlag":{
            "title":"Allow Duplicate Content",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that duplicate content is allowed.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ProductGroupUsageRootProdGrpSetup":{
            "title":"Product Group Usage Roots",
            "type":"array",
            "description":"The product group usage roots resource is used to view the usage roots of the product group.",
            "items":{
                "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageRootProdGrpSetup-item-response"
            }
        },
        "ProductGroupUsagePreferenceSetup":{
            "title":"Product Group Usage Preferences",
            "type":"array",
            "description":"The product group usage preferences resource is used to view the usage preferences of the product group.",
            "items":{
                "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsagePreferenceSetup-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProductGroupUsageEngine":{
            "title":"Product Group Usage Functions",
            "type":"array",
            "description":"The product group usage engines resource is used to view the usage engines of the product group.",
            "items":{
                "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageEngine-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageName":{
            "title":"Usage",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the product group usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Product Group Usage Functions

Type: array

Title: Product Group Usage Functions

The product group usage engines resource is used to view the usage engines of the product group.

Show Source

• Array of: object productGroupUsages-ProductGroupUsageEngine-item-response

{
    "title":"Product Group Usage Functions",
    "type":"array",
    "description":"The product group usage engines resource is used to view the usage engines of the product group.",
    "items":{
        "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageEngine-item-response"
    }
}

Nested Schema : Product Group Usage Modes

Type: array

Title: Product Group Usage Modes

The product group usage modes resource is used to view the usage mode of the product group.

Show Source

• Array of: object productGroupUsages-ProductGroupUsageModeSetup-item-response

{
    "title":"Product Group Usage Modes",
    "type":"array",
    "description":"The product group usage modes resource is used to view the usage mode of the product group.",
    "items":{
        "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageModeSetup-item-response"
    }
}

Nested Schema : Product Group Usage Preferences

Type: array

Title: Product Group Usage Preferences

The product group usage preferences resource is used to view the usage preferences of the product group.

Show Source

• Array of: object productGroupUsages-ProductGroupUsagePreferenceSetup-item-response

{
    "title":"Product Group Usage Preferences",
    "type":"array",
    "description":"The product group usage preferences resource is used to view the usage preferences of the product group.",
    "items":{
        "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsagePreferenceSetup-item-response"
    }
}

Nested Schema : Product Group Usage Roots

Type: array

Title: Product Group Usage Roots

The product group usage roots resource is used to view the usage roots of the product group.

Show Source

• Array of: object productGroupUsages-ProductGroupUsageRootProdGrpSetup-item-response

{
    "title":"Product Group Usage Roots",
    "type":"array",
    "description":"The product group usage roots resource is used to view the usage roots of the product group.",
    "items":{
        "$ref":"#/components/schemas/productGroupUsages-ProductGroupUsageRootProdGrpSetup-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productGroupUsages-ProductGroupUsageEngine-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the usage engine record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the usage engine record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the usage engine record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the usage engine record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UsageCode: string
  Maximum Length: 30

  The usage code of the usage engine.
• UsageModeCode: string
  Title: Mode

  Maximum Length: 30

  The usage mode code of the usage engine.
• UsagePrefCode: string
  Title: Name

  Maximum Length: 30

  The usage preference code of the usage engine.
• UsagePrefValue: string
  Title: Value

  Maximum Length: 100

  The usage preference value of the usage engine.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the usage engine record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage engine record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of the usage engine.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the usage engine record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageModeCode":{
            "title":"Mode",
            "maxLength":"30",
            "type":"string",
            "description":"The usage mode code of the usage engine.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "UsagePrefCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UsagePrefCode":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The usage preference code of the usage engine.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsagePrefValue":{
            "title":"Value",
            "maxLength":"100",
            "type":"string",
            "description":"The usage preference value of the usage engine.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage engine record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productGroupUsages-ProductGroupUsageModeSetup-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the usage mode setup.
• CreationDate: string (date-time)
  Read Only: true

  The date when the usage mode setup was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the usage mode setup was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the usage mode setup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModeDescText: string
  Title: Description

  Maximum Length: 250

  The usage mode description of the setup.
• UsageCode: string
  Maximum Length: 30

  The usage code of the mode setup.
• UsageModeCode: string
  Title: Mode Code

  Maximum Length: 30

  The usage mode code of the mode setup.
• UsageModeName: string
  Title: Mode

  Maximum Length: 100

  The name of the usage mode.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the usage mode setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage mode setup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of the mode setup.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the usage mode setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeDescText":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"The usage mode description of the setup.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageModeCode":{
            "title":"Mode Code",
            "maxLength":"30",
            "type":"string",
            "description":"The usage mode code of the mode setup.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageModeName":{
            "title":"Mode",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the usage mode.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage mode setup was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productGroupUsages-ProductGroupUsagePreferenceSetup-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created usage preference setup record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the usage preference set record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the usage preference setup record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the usage preference setup record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UsageCode: string
  Maximum Length: 30

  The usage code of the preference setup.
• UsageModeCode: string
  Title: Mode

  Maximum Length: 30

  The usage mode code of the preference setup.
• UsagePrefCode: string
  Title: Name

  Maximum Length: 30

  The usage preference code of the preference setup.
• UsagePrefValue: string
  Title: Value

  Maximum Length: 100

  The usage preference value of the preference setup.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the usage preference setup record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage preference set record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of the preference setup.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created usage preference setup record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageModeCode":{
            "title":"Mode",
            "maxLength":"30",
            "type":"string",
            "description":"The usage mode code of the preference setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UsagePrefCode":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"The usage preference code of the preference setup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsagePrefValue":{
            "title":"Value",
            "maxLength":"100",
            "type":"string",
            "description":"The usage preference value of the preference setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage preference setup record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productGroupUsages-ProductGroupUsageRootProdGrpSetup-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the root product group setup record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the root product group setup record was created.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  The display order number of the root product group setup.
• EndDate: string (date-time)
  Title: Effective to Date

  The date when the root product group setup ends.
• InternalName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The internal name of the product group.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the root product group setup record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the root product group setup record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProdGroupDescTxt: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the product group.
• ProdGroupId: integer (int64)
  Read Only: true

  The unique identifier of the product group.
• ProdGroupName: string
  Title: Display

  Read Only: true

  Maximum Length: 250

  The name of the product group.
• ProdGrpRootsId: integer (int64)
  The unique identifier of the product group root.
• StartDate: string (date-time)
  Title: Effective from Date

  The date when the root product group setups starts.
• UsageCode: string
  Title: Usage Code

  Maximum Length: 30

  The usage code of the root product group setup.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the root product group setup record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the root product group setup record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "title":"Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of the root product group setup.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the root product group setup record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGrpRootsId":{
            "type":"integer",
            "description":"The unique identifier of the product group root.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date when the root product group setup ends.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date when the root product group setups starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ProdGroupDescTxt":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order number of the root product group setup.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the root product group setup record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top