Jump to

• Request
• Response

Get all requests

get

/fscmRestApi/resources/11.13.18.05/planMessages

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
  
  

  • PlanIdFinder Finds the plan ID.
    Finder Variables
    • PlanId; integer; Value that uniquely identifies the B plan in the plan messages.
  • PrimaryKey Finds a message according to the primary key criteria.
    Finder Variables
    • MessageId; integer; Value that uniquely identifies the message in the plan messages.
    • PlanId; integer; Value that uniquely identifies the plan in the plan messages.
• 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:
  

  • ActionCode; integer; Action code for the creation of the message.
  • ActionCodeMeaning; string; Meaning of the action code for the creation of the message.
  • CreatedBy; string; Name of the user who created the message.
  • CreationDate; string; Date when the message was created.
  • ExecutionId; integer; Unique identifier of the execution process.
  • ItemId; integer; Unique identifier of the item associated with the message.
  • ItemName; string; Name of the item associated with the message.
  • LastUpdateDate; string; Date when the message was created.
  • LastUpdatedBy; string; Name of the user who worked on the process that resulted in the message.
  • MessageId; integer; Unique identifier of the message.
  • MessageName; string; Name of the message.
  • MessageType; string; Type of message.
  • MessageTypeMeaning; string; Meaning of the type of message.
  • ModuleCode; integer; Code of the module associated with the message.
  • ModuleCodeMeaning; string; Name of the module associated with the message.
  • OrganizationCode; string; Name of the organization associated with the message.
  • OrganizationId; integer; Unique identifier of the organization associated with the message.
  • PlanId; integer; Unique identifier of the plan associated with the message.
  • ProcessId; integer; Unique identifier of the process associated with the message.
  • ReplacedAdministratorText; string; Administrator action for the message if diagnostic settings were chosen.
  • ReplacedMessageText; string; Text of the message.
  • ReplacedUserMessageText; string; User details section of the message.
  • SubmissionTime; string; Submission time of the process that created the message.
• 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 : planMessages

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/planMessages-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object planMessages-item-response

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

Type: object

Show Source

• ActionCode: integer (int32)
  Read Only: true

  Action code for the creation of the message.
• ActionCodeMeaning: string
  Title: User Action

  Read Only: true

  Maximum Length: 80

  Meaning of the action code for the creation of the message.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the message.
• CreationDate: string (date-time)
  Read Only: true

  Date when the message was created.
• ExecutionId: integer (int64)
  Read Only: true

  Unique identifier of the execution process.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier of the item associated with the message.
• ItemName: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the item associated with the message.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the message was created.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who worked on the process that resulted in the message.
• links: array Links
  Title: Links

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

  Unique identifier of the message.
• MessageName: string
  Read Only: true

  Maximum Length: 30

  Name of the message.
• MessageType: string
  Read Only: true

  Maximum Length: 30

  Type of message.
• MessageTypeMeaning: string
  Title: Message Type

  Read Only: true

  Maximum Length: 80

  Meaning of the type of message.
• ModuleCode: integer (int32)
  Read Only: true

  Code of the module associated with the message.
• ModuleCodeMeaning: string
  Title: Module

  Read Only: true

  Maximum Length: 80

  Name of the module associated with the message.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 49

  Name of the organization associated with the message.
• OrganizationId: integer (int64)
  Read Only: true

  Unique identifier of the organization associated with the message.
• PlanId: integer
  Read Only: true

  Unique identifier of the plan associated with the message.
• ProcessId: integer (int64)
  Title: Process ID

  Read Only: true

  Unique identifier of the process associated with the message.
• ReplacedAdministratorText: string
  Administrator action for the message if diagnostic settings were chosen.
• ReplacedMessageText: string
  Title: Message Text

  Text of the message.
• ReplacedUserMessageText: string
  User details section of the message.
• SubmissionTime: string (date-time)
  Title: Submission Time

  Read Only: true

  Submission time of the process that created the message.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who worked on the process that resulted in the message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActionCodeMeaning":{
            "title":"User Action",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the action code for the creation of the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReplacedUserMessageText":{
            "type":"string",
            "description":"User details section of the message.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubmissionTime":{
            "title":"Submission Time",
            "type":"string",
            "description":"Submission time of the process that created the message.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "type":"integer",
            "description":"Action code for the creation of the message.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":3
            },
            "x-queryable":true
        },
        "ModuleCodeMeaning":{
            "title":"Module",
            "maxLength":80,
            "type":"string",
            "description":"Name of the module associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization associated with the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the item associated with the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ModuleCode":{
            "type":"integer",
            "description":"Code of the module associated with the message.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":3
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization associated with the message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the item associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Unique identifier of the process associated with the message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageTypeMeaning":{
            "title":"Message Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the type of message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacedMessageText":{
            "title":"Message Text",
            "type":"string",
            "description":"Text of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplacedAdministratorText":{
            "type":"string",
            "description":"Administrator action for the message if diagnostic settings were chosen.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of message.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Unique identifier of the message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Unique identifier of the execution process.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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 : 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