Jump to

• Request
• Response
• Examples

Query requests

get

/epm/rest/v1/requests/byName/query

Request

Query Parameters

• expand: array[string]
  Collection Format: multi

  Expands the response with additional information

  • Allowed Values: [ "workflow" ]

• fromDate: integer(int64)
  From Date in Epoch time, Difference between from and to date can be max of 90 days

  Allowed Values: [ "Epoch time eg: 1659339021" ]
• lastDays: integer(int32)
  Number of days in the past from the current date. Maximum value is 90.

  Allowed Values: [ "Non zero positive integer" ]
• myActivity: array[string]
  Collection Format: multi

  Activity names separated by comma

  • Allowed Values: [ "Assigned", "Collaborated", "Submitted", "Invited", "Contributed", "Managed" ]

• owner: array[string]
  Collection Format: multi

  Owner names separated by comma

  • Allowed Values: [ "Name of the owner" ]

• priority: array[string]
  Collection Format: multi

  Priorities separated by comma

  • Allowed Values: [ "None", "Low", "Medium", "High" ]

• requestNumber: array[string]
  Collection Format: multi

  Request Number

  • Allowed Values: [ "Nonzero positive integer" ]

• requestType: array[string]
  Collection Format: multi

  Request types separated by comma

  • Allowed Values: [ "Interactive", "Subscription", "Import", "Consolidation" ]

• stage: array[string]
  Collection Format: multi

  Stage of the request separated by comma

  • Allowed Values: [ "Submit", "Approved", "Commit", "Closed" ]

• status: array[string]
  Collection Format: multi

  Status separated by comma

  • Allowed Values: [ "Draft", "In Flight", "Recalled", "Pushed Back", "Completed", "Rejected", "Blocked", "Consolidated" ]

• timeLabelName: array[string]
  Collection Format: multi

  Time Label Name seperated by comma

  • Allowed Values: [ "Name of the time label for the request" ]

• toDate: integer(int64)
  To Date in Epoch time, Difference between from and to date can be max of 90 days

  Allowed Values: [ "Epoch time eg: 1659339021" ]
• viewName: array[string]
  Collection Format: multi

  View names separated by comma

  • Allowed Values: [ "Name of the view in application" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ItemsRequest

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
  Read Only: true
• limit: integer(int32)
• links: array links
  Read Only: true
• offset: integer(int32)
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Request"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object Request
  A Request models changes to apply to a View

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Request"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Request

Type: object

A Request models changes to apply to a View

Show Source

• actionCount: integer(int32)
  Read Only: true
• ageInDays: integer(int64)
  Read Only: true
• approvalUsers: array approvalUsers
  Read Only: true
• assignedTo: string
  Read Only: true

  This property is now deprecated. Use assignedToUser instead.
• assignedToUser: object User
• attachmentCount: integer(int32)
  Read Only: true
• autoSubmitted: boolean
• blockedUntil: integer(int64)
  Read Only: true
• commentCount: integer(int32)
  Read Only: true
• commitUsers: array commitUsers
  Read Only: true
• consolidationRequest: object IdNameDescription
• consolidationRequestNumber: integer(int32)
  Read Only: true
• consolidationRequestStatus: string
  Read Only: true

  Allowed Values: [ "DRAFT", "IN_FLIGHT", "PUSHED_BACK", "COMPLETED", "REJECTED", "RECALLED", "BLOCKED" ]

  Specifies the allowable statuses for a consolidation request.
• createdBy: string
  Read Only: true

  This property is now deprecated. Use createdByUser instead.
• createdByUser: object User
• description: string
  Read Only: true
• hasViewAccess: boolean
  Read Only: true
• id: string(uuid)
  Read Only: true
• initialSubmit: integer(int64)
  Read Only: true
• inviteeUsers: array inviteeUsers
  Read Only: true
• itemCount: integer(int32)
  Read Only: true
• links: array links
  Read Only: true
• modifiedBy: string
  Read Only: true

  This property is now deprecated. Use modifiedByUser instead.
• modifiedByUser: object User
• notes: string
  Read Only: true
• origin: string
  Read Only: true

  Allowed Values: [ "INTERACTIVE", "SUBSCRIPTION", "IMPORT", "CONSOLIDATION", "LOAD" ]

  Specifies the allowable origins for a request.
• owner: object User
• priority: string
  Read Only: true

  Allowed Values: [ "NONE", "LOW", "MEDIUM", "HIGH" ]
• requestNumber: integer(int32)
  Read Only: true
• requestType: string
  Read Only: true

  Allowed Values: [ "INTERACTIVE", "SUBSCRIPTION", "IMPORT", "CONSOLIDATION", "LOAD" ]

  Specifies the allowable request types for a request.
• sourceRequest: object IdNameLink
• stage: string
  Read Only: true

  Allowed Values: [ "SUBMIT", "APPROVE", "COMMIT", "CLOSED" ]

  Specifies the allowable stages for a request.
• status: string
  Read Only: true

  Allowed Values: [ "DRAFT", "IN_FLIGHT", "PUSHED_BACK", "COMPLETED", "REJECTED", "RECALLED", "BLOCKED", "CONSOLIDATED" ]

  Specifies the allowable statuses for a request.
• submittedBy: string
  Read Only: true

  This property is now deprecated. Use submittedByUser instead.
• submittedByUser: object User
• subscriptions: array subscriptions
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeLabel: object TimeLabel
• timeLabelChangeAllowed: boolean
• timeLabelTimestamp: integer(int64)
  Read Only: true
• timeModified: integer(int64)
  Read Only: true
• timeSubmitted: integer(int64)
  Read Only: true
• title: string
  Read Only: true
• validationErrorCount: integer(int32)
  Read Only: true
• validTransitionActions: array validTransitionActions
  Read Only: true
• valWarningCountOnClose: integer(int32)
  Read Only: true

  If the request is closed, the number of validation warnings that existed, and were allowed, at the time it was closed.
• viewId: string(uuid)
  Read Only: true
• viewName: string
  Read Only: true
• viewStatus: string
  Read Only: true

  Allowed Values: [ "DRAFT", "ACTIVE", "ARCHIVED", "DELETED" ]

  Specifies the allowable statuses for a view.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "title":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "priority":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        },
        "origin":{
            "type":"string",
            "description":"Specifies the allowable origins for a request.",
            "readOnly":true,
            "enum":[
                "INTERACTIVE",
                "SUBSCRIPTION",
                "IMPORT",
                "CONSOLIDATION",
                "LOAD"
            ]
        },
        "requestType":{
            "type":"string",
            "description":"Specifies the allowable request types for a request.",
            "readOnly":true,
            "enum":[
                "INTERACTIVE",
                "SUBSCRIPTION",
                "IMPORT",
                "CONSOLIDATION",
                "LOAD"
            ]
        },
        "status":{
            "type":"string",
            "description":"Specifies the allowable statuses for a request.",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "IN_FLIGHT",
                "PUSHED_BACK",
                "COMPLETED",
                "REJECTED",
                "RECALLED",
                "BLOCKED",
                "CONSOLIDATED"
            ]
        },
        "stage":{
            "type":"string",
            "description":"Specifies the allowable stages for a request.",
            "readOnly":true,
            "enum":[
                "SUBMIT",
                "APPROVE",
                "COMMIT",
                "CLOSED"
            ]
        },
        "requestNumber":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeSubmitted":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "description":"This property is now deprecated. Use createdByUser instead.",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "description":"This property is now deprecated. Use modifiedByUser instead.",
            "readOnly":true
        },
        "submittedBy":{
            "type":"string",
            "description":"This property is now deprecated. Use submittedByUser instead.",
            "readOnly":true
        },
        "assignedTo":{
            "type":"string",
            "description":"This property is now deprecated. Use assignedToUser instead.",
            "readOnly":true
        },
        "inviteeUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "approvalUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "commitUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "notes":{
            "type":"string",
            "readOnly":true
        },
        "itemCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "commentCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "validationErrorCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "attachmentCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "actionCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "viewId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "viewName":{
            "type":"string",
            "readOnly":true
        },
        "hasViewAccess":{
            "type":"boolean",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "consolidationRequestNumber":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "consolidationRequestStatus":{
            "type":"string",
            "description":"Specifies the allowable statuses for a consolidation request.",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "IN_FLIGHT",
                "PUSHED_BACK",
                "COMPLETED",
                "REJECTED",
                "RECALLED",
                "BLOCKED"
            ]
        },
        "consolidationRequest":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameDescription"
        },
        "initialSubmit":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "validTransitionActions":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string",
                "enum":[
                    "SUBMIT",
                    "APPROVE",
                    "PUSHBACK",
                    "REJECT",
                    "WITHDRAW",
                    "RECALL",
                    "COMMIT",
                    "CLOSE"
                ]
            }
        },
        "viewStatus":{
            "type":"string",
            "description":"Specifies the allowable statuses for a view.",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "ACTIVE",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "ageInDays":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "submittedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "assignedToUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "owner":{
            "$ref":"#/definitions/User"
        },
        "sourceRequest":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "subscriptions":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "blockedUntil":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "valWarningCountOnClose":{
            "type":"integer",
            "format":"int32",
            "description":"If the request is closed, the number of validation warnings that existed, and were allowed, at the time it was closed.",
            "readOnly":true
        },
        "timeLabel":{
            "readOnly":true,
            "$ref":"#/definitions/TimeLabel"
        },
        "timeLabelTimestamp":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeLabelChangeAllowed":{
            "type":"boolean"
        },
        "autoSubmitted":{
            "type":"boolean"
        }
    },
    "description":"A Request models changes to apply to a View"
}

Nested Schema : approvalUsers

Type: array

Read Only: true

Show Source

• Array of: object User

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : User

Type: object

Show Source

• artifactAssignments: array artifactAssignments
• associatedRoles: array associatedRoles
• dataManagerOnAny: boolean
• emailAddresses: array emailAddresses
• epmIdleSessionTimeout: integer(int32)
• firstName: string
• fullName: string
• grantPermission: string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
• homePageLayoutName: string
• id: string(uuid)
• lastName: string
• links: array links
• nameInitials: string
• preferences: object Preferences
• ssoToken: string
• userName: string
• userServiceAdministrator: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "ssoToken":{
            "type":"string"
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedRoles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "preferences":{
            "$ref":"#/definitions/Preferences"
        },
        "nameInitials":{
            "type":"string"
        },
        "grantPermission":{
            "type":"string",
            "enum":[
                "OWNER",
                "DATAMANAGER",
                "PARTICIPANT",
                "APPROVER",
                "NOTIFIED",
                "COMMITTER",
                "NONE",
                "METADATAMANAGER"
            ]
        },
        "dataManagerOnAny":{
            "type":"boolean"
        },
        "userServiceAdministrator":{
            "type":"boolean"
        },
        "epmIdleSessionTimeout":{
            "type":"integer",
            "format":"int32"
        },
        "homePageLayoutName":{
            "type":"string"
        },
        "artifactAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactAssignment"
            }
        }
    }
}

Nested Schema : commitUsers

Type: array

Read Only: true

Show Source

• Array of: object User

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : IdNameDescription

Type: object

Show Source

• description: string
• id: string(uuid)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : inviteeUsers

Type: array

Read Only: true

Show Source

• Array of: object User

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : IdNameLink

Type: object

Show Source

• description: string
  Read Only: true
• id: string(uuid)
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : subscriptions

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IdNameLink"
    }
}

Nested Schema : TimeLabel

Type: object

Show Source

• asOfTime: integer(int64)
  Read Only: true
• created: integer(int64)
  Read Only: true
• createdBy: string(uuid)
  Read Only: true
• description: string
  Read Only: true
• ftlAssignedToActiveRequest: boolean
  Read Only: true
• id: string(uuid)
  Read Only: true
• lastModified: integer(int64)
  Read Only: true
• links: array links
  Read Only: true
• modifiedBy: string(uuid)
  Read Only: true
• name: string
  Read Only: true
• ownerId: string(uuid)
  Read Only: true
• private: boolean
• rollingTimeLabelData: object RollingTimeLabelData
• timeLabelClass: string
  Read Only: true

  Allowed Values: [ "HISTORICAL", "FUTURE" ]
• timeLabelType: string
  Read Only: true

  Allowed Values: [ "SPECIFIED", "ROLLING_PERIOD", "REQUEST" ]
• timeZone: object ZoneId
• viewId: string(uuid)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "viewId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "timeLabelType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "SPECIFIED",
                "ROLLING_PERIOD",
                "REQUEST"
            ]
        },
        "asOfTime":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "rollingTimeLabelData":{
            "readOnly":true,
            "$ref":"#/definitions/RollingTimeLabelData"
        },
        "timeZone":{
            "readOnly":true,
            "$ref":"#/definitions/ZoneId"
        },
        "ownerId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "timeLabelClass":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "HISTORICAL",
                "FUTURE"
            ]
        },
        "ftlAssignedToActiveRequest":{
            "type":"boolean",
            "readOnly":true
        },
        "created":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "lastModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "private":{
            "type":"boolean"
        }
    }
}

Nested Schema : validTransitionActions

Type: array

Read Only: true

Show Source

• Array of: string
  Allowed Values: [ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT", "CLOSE" ]

{
    "type":"array",
    "readOnly":true,
    "items":{
        "type":"string",
        "enum":[
            "SUBMIT",
            "APPROVE",
            "PUSHBACK",
            "REJECT",
            "WITHDRAW",
            "RECALL",
            "COMMIT",
            "CLOSE"
        ]
    }
}

Nested Schema : artifactAssignments

Type: array

Show Source

• Array of: object ArtifactAssignment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ArtifactAssignment"
    }
}

Nested Schema : associatedRoles

Type: array

Show Source

• Array of: object Role

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role"
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Preferences

Type: object

Show Source

• actAsThisRole: string
  Allowed Values: [ "USER", "SERVICE_ADMINISTRATOR" ]
• delegateToUserId: string(uuid)
• languageTag: string
• links: array links
• outOfOffice: boolean
• profilePictureId: string(uuid)
• timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "delegateToUserId":{
            "type":"string",
            "format":"uuid"
        },
        "actAsThisRole":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE_ADMINISTRATOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

• artifact: object Artifact
• sortOrder: integer(int32)
• visible: boolean

{
    "type":"object",
    "properties":{
        "artifact":{
            "$ref":"#/definitions/Artifact"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• id: string(uuid)
• name: string
• type: string
  Allowed Values: [ "CLUSTER", "CARD" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CLUSTER",
                "CARD"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeZone

Type: object

Show Source

• displayName: string
• dstsavings: integer(int32)
• id: string
• rawOffset: integer(int32)

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "rawOffset":{
            "type":"integer",
            "format":"int32"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : RollingTimeLabelData

Type: object

Show Source

• offset: integer(int32)
• timeOfDay: string
• unit: string
  Allowed Values: [ "NONE", "END_OF_MONTH", "END_OF_YEAR", "END_OF_QUARTER", "FISCAL_QUARTER_END", "FISCAL_YEAR_END" ]

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "unit":{
            "type":"string",
            "enum":[
                "NONE",
                "END_OF_MONTH",
                "END_OF_YEAR",
                "END_OF_QUARTER",
                "FISCAL_QUARTER_END",
                "FISCAL_YEAR_END"
            ]
        },
        "timeOfDay":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneId

Type: object

Show Source

• id: string
• rules: object ZoneRules

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        }
    }
}

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset: boolean
• transitionRules: array transitionRules
• transitions: array transitions

{
    "type":"object",
    "properties":{
        "fixedOffset":{
            "type":"boolean"
        },
        "transitionRules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransitionRule"
            }
        },
        "transitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransition"
            }
        }
    }
}

Nested Schema : transitionRules

Type: array

Show Source

• Array of: object ZoneOffsetTransitionRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransitionRule"
    }
}

Nested Schema : transitions

Type: array

Show Source

• Array of: object ZoneOffsetTransition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransition"
    }
}

Nested Schema : ZoneOffsetTransitionRule

Type: object

Show Source

• dayOfMonthIndicator: integer(int32)
• dayOfWeek: string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime: object LocalTime
• midnightEndOfDay: boolean
• month: string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter: object ZoneOffset
• offsetBefore: object ZoneOffset
• standardOffset: object ZoneOffset
• timeDefinition: string
  Allowed Values: [ "UTC", "WALL", "STANDARD" ]

{
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "timeDefinition":{
            "type":"string",
            "enum":[
                "UTC",
                "WALL",
                "STANDARD"
            ]
        },
        "standardOffset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean"
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour: integer(int32)
• minute: integer(int32)
• nano: integer(int32)
• second: integer(int32)

{
    "type":"object",
    "properties":{
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ZoneOffset

Type: object

Show Source

• id: string
• rules: object ZoneRules
• totalSeconds: integer(int32)

{
    "type":"object",
    "properties":{
        "totalSeconds":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        }
    }
}

Nested Schema : ZoneOffsetTransition

Type: object

Show Source

• dateTimeAfter: string(date-time)
• dateTimeBefore: string(date-time)
• duration: object Duration
• gap: boolean
• instant: integer(int64)
• offsetAfter: object ZoneOffset
• offsetBefore: object ZoneOffset
• overlap: boolean

{
    "type":"object",
    "properties":{
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dateTimeBefore":{
            "type":"string",
            "format":"date-time"
        },
        "instant":{
            "type":"integer",
            "format":"int64"
        },
        "overlap":{
            "type":"boolean"
        },
        "dateTimeAfter":{
            "type":"string",
            "format":"date-time"
        },
        "gap":{
            "type":"boolean"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

• nano: integer(int32)
• negative: boolean
• seconds: integer(int64)
• units: array units
• zero: boolean

{
    "type":"object",
    "properties":{
        "seconds":{
            "type":"integer",
            "format":"int64"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        },
        "units":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemporalUnit"
            }
        },
        "zero":{
            "type":"boolean"
        },
        "negative":{
            "type":"boolean"
        }
    }
}

Nested Schema : units

Type: array

Show Source

• Array of: object TemporalUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemporalUnit"
    }
}

Nested Schema : TemporalUnit

Type: object

Show Source

• dateBased: boolean
• duration: object Duration
• durationEstimated: boolean
• timeBased: boolean

{
    "type":"object",
    "properties":{
        "dateBased":{
            "type":"boolean"
        },
        "timeBased":{
            "type":"boolean"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        },
        "durationEstimated":{
            "type":"boolean"
        }
    }
}

400 Response

Error Response

404 Response

Not Found

Back to Top

Examples

The following example shows how to retrieve request summary by submitting a get request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET \
  https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/byName/query?lastDays=6&expand=workflow

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "id": "d00decfe-c188-422c-a498-3bf901498b53",
            "title": "Automated Request",
            "description": "Description for Automated Request",
            "requestType": "INTERACTIVE",
            "status": "DRAFT",
            "stage": "SUBMIT",
            "priority": "NONE",
            "requestNumber": 1234,
            "timeCreated": "2022-09-09T08:22:30.987Z",
            "timeModified": "2022-09-09T08:22:40.563Z",
            "inviteeUsers": [
                {
                    "id": "f805fa38-d8e2-4e67-9aa8-87e442082526",
                    "userName": "demo1user",
                    "fullName": "demo1 user",
                    "firstName": "demo1",
                    "lastName": "user",
                    "emailAddresses": [],
                    "links": [
                        {
                           "rel": "self",
                           "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/f805fa38-d8e2-4e67-9aa8-87e442082526"
                        }
                    ],
                    "nameInitials": "du",
                    "dataManagerOnAny": false
                }
            ],
            "approvalUsers": [
               {
                  "id": "a9ea2b84-32ec-4fb5-ab8a-ca86a933959a",
                  "userName": "demo2user",
                  "fullName": "demo2 user",
                  "firstName": "demo2",
                  "lastName": "user",
                  "emailAddresses": [],
                  "links": [
                      {
                         "rel": "self",
                         "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/a9ea2b84-32ec-4fb5-ab8a-ca86a933959a"
                      }
                  ],
                  "nameInitials": "du",
                  "dataManagerOnAny": false
               }
            ],
            "commitUsers": [
               {
                  "id": "a9ea2b84-32ec-4fb5-ab8a-ca86a933959x",
                  "userName": "demo3user",
                  "fullName": "demo3 user",
                  "firstName": "demo3",
                  "lastName": "user",
                  "emailAddresses": [],
                  "links": [
                      {
                         "rel": "self",
                         "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/a9ea2b84-32ec-4fb5-ab8a-ca86a933959x"
                      }
                  ],
                  "nameInitials": "du",
                  "dataManagerOnAny": false
               }
            ],            
            "itemCount": 0,
            "commentCount": 0,
            "validationErrorCount": 0,
            "attachmentCount": 0,
            "viewId": "43d5ce15-0711-4603-8cc4-1b90c14d3136",
            "viewName": "Departments",
            "hasViewAccess": true,
            "links": [
                {
                    "rel": "delete",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53",
                    "method": "DELETE"
                },
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53"
                },
                {
                    "rel": "comments",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/comments"
                },
                {
                    "rel": "history",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/history"
                },
                {
                    "rel": "view",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/43d5ce15-0711-4603-8cc4-1b90c14d3136"
                },
                {
                    "rel": "items",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/items"
                },
                {
                    "rel": "attachments",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/attachments"
                },
                {
                    "rel": "export",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/export",
                    "method": "POST"
                },
                {
                    "rel": "approvals",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/policiesByStage/approve"
                },
                {
                    "rel": "commits",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/policiesByStage/approve"
                },
                {
                    "rel": "collaborationInvitees",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/collaborationInvitees"
                },
                {
                    "rel": "participants",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/requestParticipants"
                },
                {
                    "rel": "lineage",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/lineage"
                }
            ],
            "validTransitionActions": [],
            "viewStatus": "ACTIVE",
            "ageInDays": 3,
            "createdByUser": {
                "id": "543197b1-6156-47cc-8891-874b7257d2d0",
                "userName": "demoadmin",
                "fullName": "Demo Admin",
                "firstName": "Demo",
                "lastName": "Admin",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/543197b1-6156-47cc-8891-874b7257d2d0"
                    }
                ],
                "nameInitials": "DA"
            },
            "modifiedByUser": {
                "id": "543197b1-6156-47cc-8891-874b7257d2d0",
                "userName": "demoadmin",
                "fullName": "Demo Admin",
                "firstName": "Demo",
                "lastName": "Admin",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/543197b1-6156-47cc-8891-874b7257d2d0"
                    }
                ],
                "nameInitials": "DC"
            },
            "owner": {
                "id": "d74a9c30-e809-41fd-9479-6537c32a592e",
                "userName": "demoadmin",
                "fullName": "Demo Admin",
                "firstName": "Demo",
                "lastName": "Admin",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d74a9c30-e809-41fd-9479-6537c32a592e"
                    }
                ],
                "nameInitials": "BD"
            },
            "autoSubmitted": false
        }
    ],
    "hasMore": false,
    "totalResults": 1,
    "limit": 500,
    "count": 1
}

Back to Top