Jump to

• Request
• Response

Get action not supported

get

/fscmRestApi/resources/11.13.18.05/routingResults

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
  
  

  • PrimaryKey Finds the routing results that matches the primary key specified.
    Finder Variables
    • TransactionId; string; Unique identifier of a invoice associated with rules evaluation.
• 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:
  

  • RulesDefinitionId; string; Indicates the version identifier of the rules to be validated.
  • Submitter; string; Indicates the submitter for the transaction.
  • TransactionId; string; Indicates the ID associated with invoice submitted.
  • WorkflowIdentifier; string; Indicates the composite name and workflow name.
• 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:
  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 : routingResults

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/routingResults-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object routingResults-item-response

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Participants: array Approval Blocks
  Title: Approval Blocks

  The Participant resource lists out all the participants for a routing slip.
• RulesDefinitionId: string
  Maximum Length: 255

  Indicates the version identifier of the rules to be validated.
• Submitter: string
  Maximum Length: 255

  Indicates the submitter for the transaction.
• TransactionId: string
  Indicates the ID associated with invoice submitted.
• WorkflowIdentifier: string
  Maximum Length: 255

  Indicates the composite name and workflow name.

{
    "type":"object",
    "properties":{
        "RulesDefinitionId":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the version identifier of the rules to be validated.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkflowIdentifier":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the composite name and workflow name.",
            "nullable":true,
            "x-queryable":true
        },
        "Submitter":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the submitter for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Participants":{
            "title":"Approval Blocks",
            "type":"array",
            "description":"The Participant resource lists out all the participants for a routing slip.",
            "items":{
                "$ref":"#/components/schemas/routingResults-Participants-item-response"
            }
        },
        "TransactionId":{
            "type":"string",
            "description":"Indicates the ID associated with invoice submitted.",
            "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 : Approval Blocks

Type: array

Title: Approval Blocks

The Participant resource lists out all the participants for a routing slip.

Show Source

• Array of: object routingResults-Participants-item-response

{
    "title":"Approval Blocks",
    "type":"array",
    "description":"The Participant resource lists out all the participants for a routing slip.",
    "items":{
        "$ref":"#/components/schemas/routingResults-Participants-item-response"
    }
}

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 : routingResults-Participants-item-response

Type: object

Show Source

• DefaultOutcomeCode: string
  Default outcome code for a parallel participant.
• GroupId: integer
  Group ID for participants in parallel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListBuilders: array Approval Routings
  Title: Approval Routings

  The list builder resource lists out the list builders for a particular Participant.
• OutcomeTriggerPolicy: string
  Outcome trigger policy for parallel participants.
• ParentGroupId: integer
  Parent Group ID for participants in parallel.
• ParentParticipantId: integer
  Parent Participant ID for participant.
• ParticipantId: string
  Participant ID for participant.
• ParticipantLevel: integer
  Level of a participant.
• ParticipantName: string
  Name of a participant.
• ParticipantType: string
  Type of a participant.
• TransactionId: string
  ID associated with invoice submitted.
• VoteOutcomeCode: string
  Vote outcome code for parallel participant.
• VotePercentage: string
  Vote percentage for a parallel participant.

{
    "type":"object",
    "properties":{
        "VoteOutcomeCode":{
            "type":"string",
            "description":"Vote outcome code for parallel participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentGroupId":{
            "type":"integer",
            "description":"Parent Group ID for participants in parallel.",
            "nullable":true,
            "x-queryable":true
        },
        "ListBuilders":{
            "title":"Approval Routings",
            "type":"array",
            "description":"The list builder resource lists out the list builders for a particular Participant.",
            "items":{
                "$ref":"#/components/schemas/routingResults-Participants-ListBuilders-item-response"
            }
        },
        "ParticipantName":{
            "type":"string",
            "description":"Name of a participant.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeTriggerPolicy":{
            "type":"string",
            "description":"Outcome trigger policy for parallel participants.",
            "nullable":true,
            "x-queryable":true
        },
        "VotePercentage":{
            "type":"string",
            "description":"Vote percentage for a parallel participant.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Group ID for participants in parallel.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"string",
            "description":"ID associated with invoice submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"string",
            "description":"Participant ID for participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantLevel":{
            "type":"integer",
            "description":"Level of a participant.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultOutcomeCode":{
            "type":"string",
            "description":"Default outcome code for a parallel participant.",
            "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":{
            "type":"string",
            "description":"Type of a participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentParticipantId":{
            "type":"integer",
            "description":"Parent Participant ID for participant.",
            "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 : Approval Routings

Type: array

Title: Approval Routings

The list builder resource lists out the list builders for a particular Participant.

Show Source

• Array of: object routingResults-Participants-ListBuilders-item-response

{
    "title":"Approval Routings",
    "type":"array",
    "description":"The list builder resource lists out the list builders for a particular Participant.",
    "items":{
        "$ref":"#/components/schemas/routingResults-Participants-ListBuilders-item-response"
    }
}

Nested Schema : routingResults-Participants-ListBuilders-item-response

Type: object

Show Source

• AllowEmptyGroup: string
  Flag to indicate if empty groups are allowed.
• ApprovalAuthorityId: string
  Identifier for approval authority.
• ApprovalAuthorityRowId: string
  Identifier for one of the approval authority row.
• ApprovalGroupName: string
  Name of approval group.
• AtLeastLevels: string
  At least level for Job Level list builder.
• AtLeastRelativeToCode: string
  At least RelativeTo code for Job Level list builder.
• AtMostLevels: string
  At most level for Job Level list builder.
• AtMostRelativeToCode: string
  At most RelativeTo code for Job Level list builder.
• AutoActionCode: string
  Action to be performed on auto action.
• CallableFunction: string
  Name of callable function.
• CallableFunctionArguments: string
  Arguments for a callable function.
• DimensionId: string
  Dimension ID for a list builder.
• Id: string
  ID for a list builder.
• IncludeMgrAtLastLevel: string
  Indicates if manager at last level is included or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListBuilderTypeCode: string
  Type of list builder.
• LowestLevelCollectionOfApprovalAuthority: string
  Read Only: true

  Maximum Length: 255

  The lowest level collection used in the approval authority.
• ParticipantId: string
  Participant ID
• ResourceLbApplicationRole: string
  Name of application role.
• ResourceLbUsers: string
  Name of users.
• ResponseTypeCode: string
  Response type for list builder.
• RuleId: string
  Rule ID.
• RuleName: string
  Name of the rule.
• RulePriorityCode: string
  Rule priority for a rule.
• StartParticipantFunction: string
  Start participant function for the list builder.
• StartParticipantHierType: string
  Start participant hierarchy type for the list builder.
• StartParticipantLb: string
  List builder type for the start participant.
• StartParticipantStartDate: string (date-time)
  Start date for a start participant function.
• StartParticipantUser: string
  Name of the start participant.
• TopParticipantFunction: string
  Top participant function for the list builder.
• TopParticipantHierType: string
  Top participant hierarchy type for the list builder.
• TopParticipantLb: string
  List builder type for the top participant.
• TopParticipantStartDate: string (date-time)
  Start date for a top participant function.
• TopParticipantUser: string
  Name of the top participant.
• UnmatchedKeysOfApprovalAuthority: string
  Read Only: true

  Maximum Length: 255

  List of the lowest level collection identifiers used in the approval authority that didn't satisfy any of the approval authority rows.
• UtilizedParticipants: string
  Utilized participants for a list builder.

{
    "type":"object",
    "properties":{
        "CallableFunctionArguments":{
            "type":"string",
            "description":"Arguments for a callable function.",
            "nullable":true,
            "x-queryable":true
        },
        "TopParticipantStartDate":{
            "type":"string",
            "description":"Start date for a top participant function.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseTypeCode":{
            "type":"string",
            "description":"Response type for list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "UnmatchedKeysOfApprovalAuthority":{
            "maxLength":"255",
            "type":"string",
            "description":"List of the lowest level collection identifiers used in the approval authority that didn't satisfy any of the approval authority rows.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLbApplicationRole":{
            "type":"string",
            "description":"Name of application role.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"string",
            "description":"Rule ID.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeMgrAtLastLevel":{
            "type":"string",
            "description":"Indicates if manager at last level is included or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceLbUsers":{
            "type":"string",
            "description":"Name of users.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"string",
            "description":"Participant ID",
            "nullable":true,
            "x-queryable":true
        },
        "LowestLevelCollectionOfApprovalAuthority":{
            "maxLength":"255",
            "type":"string",
            "description":"The lowest level collection used in the approval authority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalAuthorityId":{
            "type":"string",
            "description":"Identifier for approval authority.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalGroupName":{
            "type":"string",
            "description":"Name of approval group.",
            "nullable":true,
            "x-queryable":true
        },
        "StartParticipantUser":{
            "type":"string",
            "description":"Name of the start participant.",
            "nullable":true,
            "x-queryable":true
        },
        "TopParticipantFunction":{
            "type":"string",
            "description":"Top participant function for the list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleName":{
            "type":"string",
            "description":"Name of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ListBuilderTypeCode":{
            "type":"string",
            "description":"Type of list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "StartParticipantHierType":{
            "type":"string",
            "description":"Start participant hierarchy type for the list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "AtMostRelativeToCode":{
            "type":"string",
            "description":"At most RelativeTo code for Job Level list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "AtLeastLevels":{
            "type":"string",
            "description":"At least level for Job Level list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "TopParticipantUser":{
            "type":"string",
            "description":"Name of the top participant.",
            "nullable":true,
            "x-queryable":true
        },
        "TopParticipantHierType":{
            "type":"string",
            "description":"Top participant hierarchy type for the list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "AtMostLevels":{
            "type":"string",
            "description":"At most level for Job Level list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "AtLeastRelativeToCode":{
            "type":"string",
            "description":"At least RelativeTo code for Job Level list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalAuthorityRowId":{
            "type":"string",
            "description":"Identifier for one of the approval authority row.",
            "nullable":true,
            "x-queryable":true
        },
        "TopParticipantLb":{
            "type":"string",
            "description":"List builder type for the top participant.",
            "nullable":true,
            "x-queryable":true
        },
        "RulePriorityCode":{
            "type":"string",
            "description":"Rule priority for a rule.",
            "nullable":true,
            "x-queryable":true
        },
        "StartParticipantStartDate":{
            "type":"string",
            "description":"Start date for a start participant function.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AutoActionCode":{
            "type":"string",
            "description":"Action to be performed on auto action.",
            "nullable":true,
            "x-queryable":true
        },
        "CallableFunction":{
            "type":"string",
            "description":"Name of callable function.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowEmptyGroup":{
            "type":"string",
            "description":"Flag to indicate if empty groups are allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartParticipantLb":{
            "type":"string",
            "description":"List builder type for the start participant.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"ID for a list builder.",
            "nullable":false,
            "x-queryable":true
        },
        "UtilizedParticipants":{
            "type":"string",
            "description":"Utilized participants for a list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "StartParticipantFunction":{
            "type":"string",
            "description":"Start participant function for the list builder.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionId":{
            "type":"string",
            "description":"Dimension ID for a list builder.",
            "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"
    }
}

Back to Top