Jump to

• Request
• Response

Get a workflow notification

get

/fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}

Request

Path Parameters

• taskId(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

Type: object

Show Source

• ApprovalActivities: array Approval Activities
  Title: Approval Activities

  The approval activity resource is used to view the actions performed by users on tasks.
• approvalHistory: string (byte)
  Approval history of the workflow notification.
• approvalHistoryDisplayMode: string
  Display mode of the workflow notification approval history. Valid values are INLINE, DISCLOSE, FALSE, and DIALOG.
• bipReportParameters: string (byte)
  Diagnostic parameter for the report associated with the workflow notification.
• configurableEmailNotificationEnabledFlag: boolean
  Indicates whether email notification is enabled for the workflow. The default value is false.
• configurableInAppNotificationEnabledFlag: boolean
  Indicates whether in-app notification is enabled for the workflow. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notificationBody: string (byte)
  Content of the workflow notification.
• taskId: string
  Unique identifier of a task associated with the workflow notification.
• workflowTaskSequence: string (byte)
  Diagnostic parameter for the workflow notification approval history.

{
    "type":"object",
    "properties":{
        "approvalHistoryDisplayMode":{
            "type":"string",
            "description":"Display mode of the workflow notification approval history. Valid values are INLINE, DISCLOSE, FALSE, and DIALOG.",
            "nullable":true,
            "x-queryable":true
        },
        "approvalHistory":{
            "type":"string",
            "description":"Approval history of the workflow notification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "configurableInAppNotificationEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether in-app notification is enabled for the workflow. The default value is false.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "notificationBody":{
            "type":"string",
            "description":"Content of the workflow notification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalActivities":{
            "title":"Approval Activities",
            "type":"array",
            "description":"The approval activity resource is used to view the actions performed by users on tasks.",
            "items":{
                "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "configurableEmailNotificationEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether email notification is enabled for the workflow. The default value is false.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "workflowTaskSequence":{
            "type":"string",
            "description":"Diagnostic parameter for the workflow notification approval history.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "taskId":{
            "type":"string",
            "description":"Unique identifier of a task associated with the workflow notification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "bipReportParameters":{
            "type":"string",
            "description":"Diagnostic parameter for the report associated with the workflow notification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Approval Activities

Type: array

Title: Approval Activities

The approval activity resource is used to view the actions performed by users on tasks.

Show Source

• Array of: object workflowNotificationContents-ApprovalActivities-item-response

{
    "title":"Approval Activities",
    "type":"array",
    "description":"The approval activity resource is used to view the actions performed by users on tasks.",
    "items":{
        "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-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 : workflowNotificationContents-ApprovalActivities-item-response

Type: object

Show Source

• Action: string
  Activity performed by the approver or submitter
• ActionDate: string (date-time)
  Date when the activity is performed.
• ActionDescription: string
  Maximum Length: 255

  Description of the activity performed by the user.
• ActionType: string
  Maximum Length: 255

  Type of the activity performed.
• ApprovalReason: string
  Maximum Length: 255

  Name of approval rule responsible for notification sent to user.
• ApproverName: string
  Maximum Length: 255

  Name of the approver.
• AssignmentType: string
  Maximum Length: 255

  Type of the assignment.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view the attachments added by users.
• Comments: array Comments
  Title: Comments

  The comments resource is used to view the comments added by users.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentGroupId: string
  Maximum Length: 255

  Parent Group ID for participants in parallel.
• ParticipantName: string
  Maximum Length: 255

  Name of a participant.
• ParticipantTimeLine: string
  Maximum Length: 255

  Indicates whether the approver is Current, Future, or Past approver.
• ParticipantType: string
  Maximum Length: 255

  Type of the participant.
• SequenceNumber: string
  Maximum Length: 255

  Sequence number of the approval activity entry.
• TaskId: string
  Maximum Length: 255

  Unique identifier of the task associated with the workflow notification.
• UserName: string
  Maximum Length: 255

  Name of the workflow user.

{
    "type":"object",
    "properties":{
        "Action":{
            "type":"string",
            "description":"Activity performed by the approver or submitter",
            "nullable":true,
            "x-queryable":true
        },
        "ActionType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the activity performed.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the task associated with the workflow notification.",
            "nullable":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the workflow user.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view the comments added by users.",
            "items":{
                "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-Comments-item-response"
            }
        },
        "ParentGroupId":{
            "maxLength":"255",
            "type":"string",
            "description":"Parent Group ID for participants in parallel.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of a participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantTimeLine":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the approver is Current, Future, or Past approver.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view the attachments added by users.",
            "items":{
                "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-Attachments-item-response"
            }
        },
        "ActionDate":{
            "type":"string",
            "description":"Date when the activity is performed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the activity performed by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of approval rule responsible for notification sent to user.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Sequence number of the approval activity entry.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproverName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the approver.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view the attachments added by users.

Show Source

• Array of: object workflowNotificationContents-ApprovalActivities-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view the attachments added by users.",
    "items":{
        "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-Attachments-item-response"
    }
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view the comments added by users.

Show Source

• Array of: object workflowNotificationContents-ApprovalActivities-Comments-item-response

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view the comments added by users.",
    "items":{
        "$ref":"#/components/schemas/workflowNotificationContents-ApprovalActivities-Comments-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 : workflowNotificationContents-ApprovalActivities-Attachments-item-response

Type: object

Show Source

• attachmentName: string
  Maximum Length: 255

  Name of the attachment.
• AttachmentSequenceNo: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of an attachment in the list of attachments per approval activity.
• attachmentType: string
  Maximum Length: 255

  Type of the attachment.
• attachmentURI: string
  Maximum Length: 255

  Attachment link text.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• sequenceNumber: string
  Maximum Length: 255

  Sequence number of attachments in the list of attachments.

{
    "type":"object",
    "properties":{
        "sequenceNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Sequence number of attachments in the list of attachments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attachmentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentSequenceNo":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of an attachment in the list of attachments per approval activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachmentType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "attachmentURI":{
            "maxLength":"255",
            "type":"string",
            "description":"Attachment link text.",
            "nullable":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 : 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 : workflowNotificationContents-ApprovalActivities-Comments-item-response

Type: object

Show Source

• CommentSequenceNo: string
  Maximum Length: 255

  Unique identifier of a comment in the list of comments per approval activity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SequenceNumber: string
  Maximum Length: 255

  Sequence number of comment in the list of comments
• UserComment: string
  Maximum Length: 255

  Comment provided by the user while doing an activity.
• UserName: string
  Person taking action on the task.

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Sequence number of comment in the list of comments",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserName":{
            "type":"string",
            "description":"Person taking action on the task.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentSequenceNo":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of a comment in the list of comments per approval activity.",
            "nullable":true,
            "x-queryable":true
        },
        "UserComment":{
            "maxLength":"255",
            "type":"string",
            "description":"Comment provided by the user while doing an activity.",
            "nullable":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"
    }
}

Links

ApprovalActivities

Operation: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities

Parameters:

• taskId: $request.path.taskId

The approval activity resource is used to view the actions performed by users on tasks.

Back to Top