Jump to

• Request
• Response

Update one request

patch

/fscmRestApi/resources/11.13.18.05/planAdvisors/{planAdvisorsUniqID}

Request

Path Parameters

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• ConfidenceLevel: number
  Read Only: true

  Forecasting confidence level metric of the planning advisor.
• Content: string
  Read Only: true

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

  Creation date of the planning advisor notification.
• EntityDimId: number
  Read Only: true

  Unique identifier of the dimension member associated with the planning advisor notification.
• EntityId: number
  Read Only: true

  Unique identifier of the member associated with the planning advisor notification.
• EntityLvlId: number
  Read Only: true

  Unique identifier of the level member associated with the planning advisor notification.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  The link relations associated with the resource instance.
• NotificationId: integer (int64)
  Read Only: true

  Unique identifier of the notification associated with the planning advisor.
• NotificationName: string
  Read Only: true

  Maximum Length: 250

  Name of the notification.
• NotificationType: integer (int32)
  Read Only: true

  Type of the notification.
• ParentEntityId: number
  Read Only: true

  Unique identifier of the parent member associated with the planning advisor.
• ParentEntityLvlId: number
  Read Only: true

  Unique identifier of the parent level member associated with the planning advisor.
• PlanId: integer
  Read Only: true

  Unique identifier of the plan associated with the planning advisor.
• Status: integer (int32)
  Read Only: true

  Status of the notification.

{
    "type":"object",
    "properties":{
        "ConfidenceLevel":{
            "type":"number",
            "description":"Forecasting confidence level metric of the planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":6,
                "scale":3
            },
            "x-queryable":true
        },
        "Content":{
            "type":"string",
            "description":"Content of the planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the planning advisor notification.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityDimId":{
            "type":"number",
            "description":"Unique identifier of the dimension member associated with the planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"number",
            "description":"Unique identifier of the member associated with the planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityLvlId":{
            "type":"number",
            "description":"Unique identifier of the level member associated with the planning advisor notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the notification was created in the planning advisor.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Unique identifier of the notification associated with the planning advisor.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotificationName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationType":{
            "type":"integer",
            "description":"Type of the notification.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"number",
            "description":"Unique identifier of the parent member associated with the planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityLvlId":{
            "type":"number",
            "description":"Unique identifier of the parent level member associated with the planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the planning advisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status of the 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