Jump to

• Request
• Response

Get one request for a hyperparameter tuning notification

get

/fscmRestApi/resources/11.13.18.05/htPlanAdvisors/{htPlanAdvisorsUniqID}

Request

Path Parameters

• htPlanAdvisorsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and NotificationId ---for the Hyperparameter Tuning Notifications resource and used to uniquely identify an instance of Hyperparameter Tuning Notifications. The client should not generate the hash key value. Instead, the client should query on the Hyperparameter Tuning Notifications collection resource with a filter on the primary key values in order to navigate to a specific instance of Hyperparameter Tuning Notifications.
  
  For example: htPlanAdvisors?q=PlanId=<value1>;NotificationId=<value2>

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : htPlanAdvisors-item-response

Type: object

Show Source

• ConfidenceLevel: number
  Read Only: true

  Confidence level of the hyperparameter tuning planning advisor.
• Content: string (byte)
  Read Only: true

  Content of the hyperparameter tuning planning advisor.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the hyperparameter tuning planning advisor notification.
• EntityDimId: integer
  Read Only: true

  Unique identifier of the dimension entity associated with the hyperparameter tuning planning advisor notification.
• EntityId: integer
  Read Only: true

  Unique identifier of the entity associated with the hyperparameter tuning planning advisor notification.
• EntityLvlId: integer
  Read Only: true

  Unique identifier of the level entity associated with the hyperparameter tuning planning advisor notification.
• InventoryItemId: number
  Read Only: true

  Unique identifier of the item inventory associated with the hyperparameter tuning planning advisor notification.
• IsDisclosed: string
  Unique identifier of the disclosed attribute associated with the hyperparameter tuning planning advisor notification.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Item description associated with the external machine learning forecast planning advisor notification.
• ItemDisplayName: string
  Read Only: true

  Maximum Length: 541

  Item display name associated with the hyperparameter tuning planning advisor notification.
• ItemName: string
  Read Only: true

  Maximum Length: 300

  Item name associated with the external machine learning forecast planning advisor notification.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the hyperparameter tuning notification was created in the planning advisor.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationId: integer
  Unique identifier of the hyperparameter tuning notification.
• NotificationTitle: string
  Title of the hyperparameter tuning notification.
• NotificationType: integer (int32)
  Read Only: true

  Type of the hyperparameter tuning notification.
• PlanId: integer
  Unique identifier of the plan associated with the hyperparameter tuning planning advisor notification.
• ProfileName: string
  Read Only: true

  Maximum Length: 250

  Name of the profile associated with the hyperparameter tuning planning advisor notification.
• Status: integer (int32)
  Read Only: true

  Status of the hyperparameter tuning notification.

{
    "type":"object",
    "properties":{
        "ConfidenceLevel":{
            "type":"number",
            "description":"Confidence level of the hyperparameter tuning planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":6,
                "scale":3
            },
            "x-queryable":true
        },
        "Content":{
            "type":"string",
            "description":"Content of the hyperparameter tuning planning advisor.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the hyperparameter tuning planning advisor notification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityDimId":{
            "type":"integer",
            "description":"Unique identifier of the dimension entity associated with the hyperparameter tuning planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Unique identifier of the entity associated with the hyperparameter tuning planning advisor notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityLvlId":{
            "type":"integer",
            "description":"Unique identifier of the level entity associated with the hyperparameter tuning planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"number",
            "description":"Unique identifier of the item inventory associated with the hyperparameter tuning planning advisor notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsDisclosed":{
            "type":"string",
            "description":"Unique identifier of the disclosed attribute associated with the hyperparameter tuning planning advisor notification.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Item description associated with the external machine learning forecast planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDisplayName":{
            "maxLength":541,
            "type":"string",
            "description":"Item display name associated with the hyperparameter tuning planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Item name associated with the external machine learning forecast planning advisor notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the hyperparameter tuning notification was created in the planning advisor.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Unique identifier of the hyperparameter tuning notification.",
            "nullable":false,
            "x-queryable":true
        },
        "NotificationTitle":{
            "type":"string",
            "description":"Title of the hyperparameter tuning notification.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationType":{
            "type":"integer",
            "description":"Type of the hyperparameter tuning notification.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the hyperparameter tuning planning advisor notification.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the profile associated with the hyperparameter tuning planning advisor notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status of the hyperparameter tuning notification.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "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