Jump to

• Request
• Response

Get an access request

get

/fscmRestApi/resources/11.13.18.05/advancedAccessRequestApprovals/{AccessRequestId}

Request

Path Parameters

• AccessRequestId(required): integer(int64)
  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 : advancedAccessRequestApprovals-item-response

Type: object

Show Source

• AccessRequestId: string
  Read Only: true

  Maximum Length: 18

  The ID of a submitted access request.
• checkProcurement: array Access Request Procurement Agent Checks
  Title: Access Request Procurement Agent Checks

  The check performed on an access request for procurement.
• ControlAnalysisCompletedOn: string (date)
  Read Only: true

  The date of the last successful analysis job run against active access controls.
• ControlViolationCount: string
  Read Only: true

  Maximum Length: 20

  The number of active controls under violation.
• CreationDate: string (date-time)
  Read Only: true

  The timestamp at which the access request was recorded.
• IsAnalyzingRisk: string
  Read Only: true

  Maximum Length: 5

  Boolean value that indicates if the risk analysis job is currently running.
• IsRequestedByUserValid: string
  Read Only: true

  Maximum Length: 5

  Boolean value that indicates if the person who submitted the access request is still a valid user in the system.
• IsRequestedForUserValid: string
  Read Only: true

  Maximum Length: 5

  Boolean value that indicates if the requested-for person is still a valid user in the system.
• IsTemporaryAccess: string
  Read Only: true

  Maximum Length: 5

  Indicates if the request is time bound.
• Justification: string
  Read Only: true

  Maximum Length: 4000

  A brief explanation for the access request.
• links: array Links
  Title: Links

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

  The person ID of the user.
• procurement: array Access Request Procurement Agent Actions
  Title: Access Request Procurement Agent Actions

  The procurement resource is used to view all the procurement agent actions associated to an access request.
• RequestedByDisplayName: string
  Read Only: true

  Maximum Length: 255

  The display name of the person submitting the access request.
• RequestedByUserGuid: string
  Read Only: true

  Maximum Length: 64

  The GUID of the person submitting the access request.
• RequestedForDisplayName: string
  Read Only: true

  Maximum Length: 255

  The display name of the person the request is submitted for.
• RequestedForUserGuid: string
  Read Only: true

  Maximum Length: 64

  The GUID of the person the request is submitted for.
• RequestStatus: string
  Read Only: true

  Maximum Length: 40

  The current status of the access request.
• securityValues: array Access Request Procurement Agent Security Values
  Title: Access Request Procurement Agent Security Values

  The security values resource is used to view procurement business units associated to an access request.
• TotalControlsCount: integer (int64)
  Read Only: true

  The total number of active controls at the time the request was submitted.

{
    "type":"object",
    "properties":{
        "checkProcurement":{
            "title":"Access Request Procurement Agent Checks",
            "type":"array",
            "description":"The check performed on an access request for procurement.",
            "items":{
                "$ref":"#/components/schemas/advancedAccessRequestApprovals-checkProcurement-item-response"
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The timestamp at which the access request was recorded.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsTemporaryAccess":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates if the request is time bound.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessRequestId":{
            "maxLength":18,
            "type":"string",
            "description":"The ID of a submitted access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsAnalyzingRisk":{
            "maxLength":5,
            "type":"string",
            "description":"Boolean value that indicates if the risk analysis job is currently running.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsRequestedByUserValid":{
            "maxLength":5,
            "type":"string",
            "description":"Boolean value that indicates if the person who submitted the access request is still a valid user in the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedByUserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The GUID of the person submitting the access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlAnalysisCompletedOn":{
            "type":"string",
            "description":"The date of the last successful analysis job run against active access controls.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedForDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"The display name of the person the request is submitted for.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"The display name of the person submitting the access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The person ID of the user.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "securityValues":{
            "title":"Access Request Procurement Agent Security Values",
            "type":"array",
            "description":"The security values resource is used to view procurement business units associated to an access request.",
            "items":{
                "$ref":"#/components/schemas/advancedAccessRequestApprovals-securityValues-item-response"
            }
        },
        "procurement":{
            "title":"Access Request Procurement Agent Actions",
            "type":"array",
            "description":"The procurement resource is used to view all the procurement agent actions associated to an access request.",
            "items":{
                "$ref":"#/components/schemas/advancedAccessRequestApprovals-procurement-item-response"
            }
        },
        "RequestedForUserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The GUID of the person the request is submitted for.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Justification":{
            "maxLength":4000,
            "type":"string",
            "description":"A brief explanation for the access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalControlsCount":{
            "type":"integer",
            "description":"The total number of active controls at the time the request was submitted.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IsRequestedForUserValid":{
            "maxLength":5,
            "type":"string",
            "description":"Boolean value that indicates if the requested-for person is still a valid user in the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlViolationCount":{
            "maxLength":20,
            "type":"string",
            "description":"The number of active controls under violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "maxLength":40,
            "type":"string",
            "description":"The current status of the access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Access Request Procurement Agent Checks

Type: array

Title: Access Request Procurement Agent Checks

The check performed on an access request for procurement.

Show Source

• Array of: object advancedAccessRequestApprovals-checkProcurement-item-response

{
    "title":"Access Request Procurement Agent Checks",
    "type":"array",
    "description":"The check performed on an access request for procurement.",
    "items":{
        "$ref":"#/components/schemas/advancedAccessRequestApprovals-checkProcurement-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 : Access Request Procurement Agent Actions

Type: array

Title: Access Request Procurement Agent Actions

The procurement resource is used to view all the procurement agent actions associated to an access request.

Show Source

• Array of: object advancedAccessRequestApprovals-procurement-item-response

{
    "title":"Access Request Procurement Agent Actions",
    "type":"array",
    "description":"The procurement resource is used to view all the procurement agent actions associated to an access request.",
    "items":{
        "$ref":"#/components/schemas/advancedAccessRequestApprovals-procurement-item-response"
    }
}

Nested Schema : Access Request Procurement Agent Security Values

Type: array

Title: Access Request Procurement Agent Security Values

The security values resource is used to view procurement business units associated to an access request.

Show Source

• Array of: object advancedAccessRequestApprovals-securityValues-item-response

{
    "title":"Access Request Procurement Agent Security Values",
    "type":"array",
    "description":"The security values resource is used to view procurement business units associated to an access request.",
    "items":{
        "$ref":"#/components/schemas/advancedAccessRequestApprovals-securityValues-item-response"
    }
}

Nested Schema : advancedAccessRequestApprovals-checkProcurement-item-response

Type: object

Show Source

• AccessRequestId: integer (int64)
  Read Only: true

  The ID of a submitted access request.
• HasProcurementAccess: string
  Read Only: true

  Maximum Length: 5

  Boolean value that indicates if an access request has procurement records.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "HasProcurementAccess":{
            "maxLength":5,
            "type":"string",
            "description":"Boolean value that indicates if an access request has procurement records.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessRequestId":{
            "type":"integer",
            "description":"The ID of a submitted access request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : advancedAccessRequestApprovals-procurement-item-response

Type: object

Show Source

• AarPaaRequestId: integer (int64)
  Read Only: true

  The ID of the procurement agent action.
• AccessOthersLevelCode: string
  Read Only: true

  Maximum Length: 30

  The access level to documents owned by other procurement agents for each procurement business unit.
• AccessRequestId: integer (int64)
  Read Only: true

  The ID of a submitted access request.
• Action: string
  Read Only: true

  Maximum Length: 100

  The action associated to the business unit for which the procurement agent has the access.
• Allowed: string
  Read Only: true

  Maximum Length: 1

  Boolean that indicates if the procurement agent has the access to the action.
• Editable: string
  Read Only: true

  Maximum Length: 1

  Boolean that indicates if the procurement agent access record can be edited.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecurityValue: string
  Read Only: true

  Maximum Length: 240
• SecurityValueId: integer (int64)
  Read Only: true

  The ID of the business unit.

{
    "type":"object",
    "properties":{
        "SecurityValueId":{
            "type":"integer",
            "description":"The ID of the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Action":{
            "maxLength":100,
            "type":"string",
            "description":"The action associated to the business unit for which the procurement agent has the access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessRequestId":{
            "type":"integer",
            "description":"The ID of a submitted access request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Editable":{
            "maxLength":1,
            "type":"string",
            "description":"Boolean that indicates if the procurement agent access record can be edited.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AarPaaRequestId":{
            "type":"integer",
            "description":"The ID of the procurement agent action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccessOthersLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The access level to documents owned by other procurement agents for each procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Allowed":{
            "maxLength":1,
            "type":"string",
            "description":"Boolean that indicates if the procurement agent has the access to the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurityValue":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":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 : advancedAccessRequestApprovals-securityValues-item-response

Type: object

Show Source

• AccessRequestId: integer (int64)
  Read Only: true

  The ID of a submitted access request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecurityValue: string
  Read Only: true

  Maximum Length: 240

  The name of the business unit.
• SecurityValueId: string
  Read Only: true

  Maximum Length: 37

  The ID of the business unit.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecurityValueId":{
            "maxLength":37,
            "type":"string",
            "description":"The ID of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessRequestId":{
            "type":"integer",
            "description":"The ID of a submitted access request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecurityValue":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":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

checkProcurement

Operation: /fscmRestApi/resources/11.13.18.05/advancedAccessRequestApprovals/{AccessRequestId}/child/checkProcurement

Parameters:

• AccessRequestId: $request.path.AccessRequestId

The check performed on an access request for procurement.

procurement

Operation: /fscmRestApi/resources/11.13.18.05/advancedAccessRequestApprovals/{AccessRequestId}/child/procurement

Parameters:

• AccessRequestId: $request.path.AccessRequestId

The procurement resource is used to view all the procurement agent actions associated to an access request.

securityValues

Operation: /fscmRestApi/resources/11.13.18.05/advancedAccessRequestApprovals/{AccessRequestId}/child/securityValues

Parameters:

• AccessRequestId: $request.path.AccessRequestId

The security values resource is used to view procurement business units associated to an access request.

Back to Top