Jump to

• Request
• Response

Get all default attributes for a line

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lineDefaultAttributeGroups

Request

Path Parameters

• supplierNegotiationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 the single default line attribute group by its primary key, GroupID.
    Finder Variables:
    • GroupId; integer; Value that uniquely identifies the default line attribute group.
• 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
• 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: string
  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: string
  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 : supplierNegotiations-lineDefaultAttributeGroups

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierNegotiations-lineDefaultAttributeGroups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-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 : supplierNegotiations-lineDefaultAttributeGroups-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the default line attribute group.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the default line attribute group.
• GroupId: integer (int64)
  Read Only: true

  Value that identifies the default line attribute group.
• GroupName: string
  Title: Section

  Read Only: true

  Maximum Length: 240

  Name of the default line attribute group.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the default line attribute group.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the default line attribute group.
• lineDefaultAttributes: array Default Line Attributes
  Title: Default Line Attributes

  Details of all attributes contained in an attribute group in a supplier negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the default line attribute group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the default line attribute group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that identifies the default line attribute group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "GroupName":{
            "title":"Section",
            "maxLength":240,
            "type":"string",
            "description":"Name of the default line attribute group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the default line attribute group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the default line attribute group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "lineDefaultAttributes":{
            "title":"Default Line Attributes",
            "type":"array",
            "description":"Details of all attributes contained in an attribute group in a supplier negotiation line.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Default Line Attributes

Type: array

Title: Default Line Attributes

Details of all attributes contained in an attribute group in a supplier negotiation line.

Show Source

• Array of: object supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-item-response

{
    "title":"Default Line Attributes",
    "type":"array",
    "description":"Details of all attributes contained in an attribute group in a supplier negotiation line.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-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 : supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-item-response

Type: object

Show Source

• AttributeId: number
  Read Only: true

  Value that identifies the default line attribute.
• AttributeName: string
  Title: Attribute

  Read Only: true

  Maximum Length: 4000

  Description of the default line attribute.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the default line attribute.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the default line attribute.
• DisplayTargetFlag: boolean
  Title: Display target

  Read Only: true

  Maximum Length: 1

  Contains a value of true or false. If true, the supplier is allowed to view the default line attribute target value; if false, they aren't. The default is false.
• GroupId: integer (int64)
  Read Only: true

  Value that identifies the default line attribute group.
• GroupName: string
  Read Only: true

  Name of the default line attribute group.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the default line attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the default line attribute.
• lineDefaultAcceptableResponseScoreValues: array Response Values for Default Line Attribute
  Title: Response Values for Default Line Attribute

  Information on score values corresponding to acceptable responses during line attribute scoring.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Specifies whether the response for the default line attribute is required. Valid values are required, optional, or not needed. Accepted values are defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.
• ResponseTypeCode: string
  Title: Response

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies whether the response for the default line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. Accepted values are defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.
• TargetDateValue: string (date)
  Title: Target

  Read Only: true

  Target value of the default line attribute, applicable to dates.
• TargetNumberValue: number
  Title: Target

  Read Only: true

  Target value for the default line attribute. This value is applicable for numbers.
• TargetTextValue: string
  Title: Target

  Read Only: true

  Maximum Length: 4000

  Target text or URL (Uniform Resource Locator) values of the default line attribute.
• ValueType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Display name of the data type for the default line attribute response, such as text, number, date, or URL (Uniform Resource Locator). Accepted values are defined in the lookup type Attribute Value Type.
• ValueTypeCode: string
  Title: Value Type

  Read Only: true

  Maximum Length: 3

  Abbreviation identifying the type of value for the default line attribute response. Valid values are TXT, NUM, DAT, and URL. Accepted values are defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE.
• Weight: number
  Title: Weight

  Read Only: true

  Importance of the default line attribute relative to other default line attributes. The application uses this weight to calculate the line score.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"number",
            "description":"Value that identifies the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            },
            "x-queryable":true
        },
        "AttributeName":{
            "title":"Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the default line attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DisplayTargetFlag":{
            "title":"Display target",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains a value of true or false. If true, the supplier is allowed to view the default line attribute target value; if false, they aren't. The default is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that identifies the default line attribute group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "GroupName":{
            "type":"string",
            "description":"Name of the default line attribute group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ResponseType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Specifies whether the response for the default line attribute is required. Valid values are required, optional, or not needed. Accepted values are defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ResponseTypeCode":{
            "title":"Response",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies whether the response for the default line attribute is required. Valid values are REQUIRED, OPTIONAL, and DISPLAY_ONLY. Accepted values are defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetDateValue":{
            "title":"Target",
            "type":"string",
            "description":"Target value of the default line attribute, applicable to dates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetNumberValue":{
            "title":"Target",
            "type":"number",
            "description":"Target value for the default line attribute. This value is applicable for numbers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TargetTextValue":{
            "title":"Target",
            "maxLength":4000,
            "type":"string",
            "description":"Target text or URL (Uniform Resource Locator) values of the default line attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ValueType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Display name of the data type for the default line attribute response, such as text, number, date, or URL (Uniform Resource Locator). Accepted values are defined in the lookup type Attribute Value Type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ValueTypeCode":{
            "title":"Value Type",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation identifying the type of value for the default line attribute response. Valid values are TXT, NUM, DAT, and URL. Accepted values are defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Importance of the default line attribute relative to other default line attributes. The application uses this weight to calculate the line score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "lineDefaultAcceptableResponseScoreValues":{
            "title":"Response Values for Default Line Attribute",
            "type":"array",
            "description":"Information on score values corresponding to acceptable responses during line attribute scoring.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-lineDefaultAcceptableResponseScoreValues-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Response Values for Default Line Attribute

Type: array

Title: Response Values for Default Line Attribute

Information on score values corresponding to acceptable responses during line attribute scoring.

Show Source

• Array of: object supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-lineDefaultAcceptableResponseScoreValues-item-response

{
    "title":"Response Values for Default Line Attribute",
    "type":"array",
    "description":"Information on score values corresponding to acceptable responses during line attribute scoring.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-lineDefaultAcceptableResponseScoreValues-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 : supplierNegotiations-lineDefaultAttributeGroups-lineDefaultAttributes-lineDefaultAcceptableResponseScoreValues-item-response

Type: object

Show Source

• AttributeId: number
  Read Only: true

  Value that identifies the default line attribute.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the response value for the default line attribute.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the response value for the default line attribute.
• FromDateResponseValue: string (date)
  Title: From Response Value

  Read Only: true

  Earliest date in the date range used by the application to score the attribute. Applicable for date values.
• FromNumberResponseValue: number
  Title: From Response Value

  Read Only: true

  Lowest number in the range used by the application to score the attribute. Applicable for numeric values.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user last updated the response value for the default line attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the response value for the default line attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Score: number
  Title: Score

  Read Only: true

  Score assigned by the application to each attribute response.
• ScoreId: number
  Read Only: true

  Value that uniquely identifies the score for the acceptable response of the default line attribute.
• TextResponseValue: string
  Title: Response Value

  Read Only: true

  Maximum Length: 240

  Value accepted by the application for the attribute. Applies to text values.
• ToDateResponseValue: string (date)
  Title: To Response Value

  Read Only: true

  Most recent date in the date range used by the application to score the attribute. Applicable for date values.
• ToNumberResponseValue: number
  Title: To Response Value

  Read Only: true

  Highest number in the range used by the application to score the attribute. Applicable for numeric values.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"number",
            "description":"Value that identifies the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the response value for the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the response value for the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromDateResponseValue":{
            "title":"From Response Value",
            "type":"string",
            "description":"Earliest date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromNumberResponseValue":{
            "title":"From Response Value",
            "type":"number",
            "description":"Lowest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user last updated the response value for the default line attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the response value for the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score assigned by the application to each attribute response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "ScoreId":{
            "type":"number",
            "description":"Value that uniquely identifies the score for the acceptable response of the default line attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            },
            "x-queryable":true
        },
        "TextResponseValue":{
            "title":"Response Value",
            "maxLength":240,
            "type":"string",
            "description":"Value accepted by the application for the attribute. Applies to text values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToDateResponseValue":{
            "title":"To Response Value",
            "type":"string",
            "description":"Most recent date in the date range used by the application to score the attribute. Applicable for date values.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ToNumberResponseValue":{
            "title":"To Response Value",
            "type":"number",
            "description":"Highest number in the range used by the application to score the attribute. Applicable for numeric values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Back to Top