Jump to

• Request
• Response
• Examples

Update all incidents

patch

/fscmRestApi/resources/11.13.18.05/advancedControls/{Id}/child/incidents/{Id4}

Request

Path Parameters

• Id(required): integer
  The unique identifier of the advanced control.
• Id4(required): integer
  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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• additionalInformations: array Flexfields
  Title: Flexfields

  The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about advanced control incidents.
• ControlName: string
  The name of the advanced control that generated the incident.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
• ResultInvestigator: string
  Maximum Length: 255

  The investigator assigned to the advanced-control incident.
• RevisionDate: string (date-time)
  The date and time the advanced-control incident was revised.
• Status: string
  Maximum Length: 30

  The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved.",
            "nullable":true
        },
        "ControlName":{
            "type":"string",
            "description":"The name of the advanced control that generated the incident.",
            "nullable":true
        },
        "ResultInvestigator":{
            "maxLength":255,
            "type":"string",
            "description":"The investigator assigned to the advanced-control incident.",
            "nullable":true
        },
        "RevisionDate":{
            "type":"string",
            "description":"The date and time the advanced-control incident was revised.",
            "format":"date-time",
            "nullable":true
        },
        "comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view or modify comments written about advanced control incidents.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-comments-item-patch-request"
            }
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-perspectives-item-patch-request"
            }
        },
        "additionalInformations":{
            "title":"Flexfields",
            "type":"array",
            "description":"The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-additionalInformations-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.

Show Source

• Array of: object advancedControls-incidents-additionalInformations-item-patch-request

{
    "title":"Flexfields",
    "type":"array",
    "description":"The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-additionalInformations-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view or modify comments written about advanced control incidents.

Show Source

• Array of: object advancedControls-incidents-comments-item-patch-request

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view or modify comments written about advanced control incidents.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-comments-item-patch-request"
    }
}

Nested Schema : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.

Show Source

• Array of: object advancedControls-incidents-perspectives-item-patch-request

{
    "title":"Perspectives",
    "type":"array",
    "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-perspectives-item-patch-request"
    }
}

Nested Schema : advancedControls-incidents-additionalInformations-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The segment that appears in a flexfield associated to the advanced control only in a defined context.
• Id: string
  Maximum Length: 255

  The unique identifier of a flexfield associated to the advanced control.

{
    "type":"object",
    "properties":{
        "Id":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of a flexfield associated to the advanced control.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The segment that appears in a flexfield associated to the advanced control only in a defined context.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : advancedControls-incidents-comments-item-patch-request

Type: object

Show Source

• Delegated: string
  Default Value: N

  The flag indicating that the advanced-control comment was delegated.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The text of the advanced-control comment.

{
    "type":"object",
    "properties":{
        "Delegated":{
            "type":"string",
            "description":"The flag indicating that the advanced-control comment was delegated.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":2000,
            "type":"string",
            "description":"The text of the advanced-control comment.",
            "nullable":false
        }
    }
}

Nested Schema : advancedControls-incidents-perspectives-item-patch-request

Type: object

Show Source

• IncidentId: string
  The unique identifier of the advanced control incident the perspective value is assigned to.
• Name: string
  Maximum Length: 150

  The name of the perspective value assigned to the advanced control.
• perspectives: array Perspective Items
  Title: Perspective Items

  The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
• TreeId: integer
  The unique identifier of the perspective hierarchy.

{
    "type":"object",
    "properties":{
        "TreeId":{
            "type":"integer",
            "description":"The unique identifier of the perspective hierarchy.",
            "nullable":false
        },
        "perspectives":{
            "title":"Perspective Items",
            "type":"array",
            "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-perspectives-perspectives-item-patch-request"
            }
        },
        "IncidentId":{
            "type":"string",
            "description":"The unique identifier of the advanced control incident the perspective value is assigned to.",
            "nullable":true
        },
        "Name":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the perspective value assigned to the advanced control.",
            "nullable":false
        }
    }
}

Nested Schema : Perspective Items

Type: array

Title: Perspective Items

The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.

Show Source

• Array of: object advancedControls-incidents-perspectives-perspectives-item-patch-request

{
    "title":"Perspective Items",
    "type":"array",
    "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-perspectives-perspectives-item-patch-request"
    }
}

Nested Schema : advancedControls-incidents-perspectives-perspectives-item-patch-request

Type: object

Show Source

• IncidentId: string
  The unique identifier of the advanced control incident the perspective value is assigned to.
• Name: string
  Maximum Length: 150

  The name of the perspective value assigned to the advanced control.
• PerspItemId: integer
  The unique identifier of the perspective value assigned to the advanced control.
• TreeId: integer
  The unique identifier of the perspective hierarchy.

{
    "type":"object",
    "properties":{
        "TreeId":{
            "type":"integer",
            "description":"The unique identifier of the perspective hierarchy.",
            "nullable":false
        },
        "IncidentId":{
            "type":"string",
            "description":"The unique identifier of the advanced control incident the perspective value is assigned to.",
            "nullable":true
        },
        "PerspItemId":{
            "type":"integer",
            "description":"The unique identifier of the perspective value assigned to the advanced control.",
            "nullable":false
        },
        "Name":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the perspective value assigned to the advanced control.",
            "nullable":false
        }
    }
}

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 : advancedControls-incidents-item-response

Type: object

Show Source

• AccessPointName: string
  Read Only: true

  Maximum Length: 256

  The terminal access point in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.
• AccessPointType: string
  Read Only: true

  Maximum Length: 256

  Whether the focal access point of an access incident is a privilege or a role. This does not apply to transaction incidents.
• additionalInformations: array Flexfields
  Title: Flexfields

  The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.
• ClosedBy: string
  Read Only: true

  Maximum Length: 64

  The user who closed the advanced-control incident.
• ClosedDate: string (date)
  Read Only: true

  The date and time when the advanced-control incident was closed.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about advanced control incidents.
• ConflictingAccPointName: string
  Read Only: true

  Maximum Length: 256

  The name of an access point that is in conflict with the access point identified by the AccessPointName attribute.
• ConflictingRoles: string
  Read Only: true

  Maximum Length: 4000

  For an access incident, access paths that conflict with the access path that is the focus of the incident. This does not apply to transaction incidents.
• ControlId: integer (int64)
  Read Only: true

  The unique identifier of the advanced control that generated the incident.
• ControlName: string
  The name of the advanced control that generated the incident.
• ControlType: integer (int64)
  Read Only: true

  The type of advanced control that generated the incident, access or transaction.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the advanced-control incident.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the advanced-control incident was created.
• DataSource: string
  Read Only: true

  Maximum Length: 256

  The data source in which the incident occurred.
• Entitlement: string
  Read Only: true

  Maximum Length: 4000

  The entitlement, if any, to which the focal access point of an access incident belongs. This does not apply to transaction incidents.
• GlobalUserId: integer (int64)
  Read Only: true

  The unique identifier of the global user.
• GlobalUserName: string
  Read Only: true

  Maximum Length: 256

  The unique global user name.
• GroupingValue: string
  Read Only: true

  Maximum Length: 4000

  For a transaction incident, Grouping Value reports the value that grouped result records have in common. For an access incident, Grouping Value is not used.
• Id: string
  Read Only: true

  Maximum Length: 256

  The unique identifier of the advanced-control incident.
• IncidentInformation: string
  Read Only: true

  Maximum Length: 4000

  For a transaction incident, Incident Information is the value returned for the first attribute selected as a result attribute for the control. For an access incident, Incident Information is the path by which a user reaches an access point that is the focus of the incident.
• IncidentInformationCodes: string
  Read Only: true

  Maximum Length: 4000

  The unique codes that correlate to the incident information path value. These codes represent the job, duty, and privilege codes.
• IncidentVersion: integer
  Read Only: true

  The version of the incident.
• IsIntraRoleViol: string
  Read Only: true

  Maximum Length: 1

  Whether the incident is an "intra-role" conflict, which is defined as involving access points available within a single role.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the advanced-control incident was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the advanced-control incident most recently.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
• Priority: integer (int64)
  Read Only: true

  The priority of the advanced-control incident.
• ResultGroup: string
  Read Only: true

  Maximum Length: 4000

  For a transaction incident, Group is a descriptor that indicates what grouped return values have in common. For example, a filter that uses the Equals condition groups records in which values are equal, and Group reports the business object and attribute whose values are equal. For an access incident, Group is one or more access paths that conflict with the Incident Information path.
• ResultInvestigator: string
  Maximum Length: 255

  The investigator assigned to the advanced-control incident.
• RevisionDate: string (date-time)
  The date and time the advanced-control incident was revised.
• Role: string
  Read Only: true

  Maximum Length: 4000

  The parent role in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.
• State: string
  Read Only: true

  Maximum Length: 30

  The state of the advanced-control incident. Values include In Investigation, Approved, and Closed.
• Status: string
  Maximum Length: 30

  The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved.
• UserFirstName: string
  Read Only: true

  Maximum Length: 256

  The first name of the user involved in the incident result.
• UserLastName: string
  Read Only: true

  Maximum Length: 256

  The last name of the user involved in the incident result.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the advanced-control incident was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlName":{
            "type":"string",
            "description":"The name of the advanced control that generated the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "ResultInvestigator":{
            "maxLength":255,
            "type":"string",
            "description":"The investigator assigned to the advanced-control incident.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastName":{
            "maxLength":256,
            "type":"string",
            "description":"The last name of the user involved in the incident result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictingRoles":{
            "maxLength":4000,
            "type":"string",
            "description":"For an access incident, access paths that conflict with the access path that is the focus of the incident. This does not apply to transaction incidents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultGroup":{
            "maxLength":4000,
            "type":"string",
            "description":"For a transaction incident, Group is a descriptor that indicates what grouped return values have in common. For example, a filter that uses the Equals condition groups records in which values are equal, and Group reports the business object and attribute whose values are equal. For an access incident, Group is one or more access paths that conflict with the Incident Information path.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentInformation":{
            "maxLength":4000,
            "type":"string",
            "description":"For a transaction incident, Incident Information is the value returned for the first attribute selected as a result attribute for the control. For an access incident, Incident Information is the path by which a user reaches an access point that is the focus of the incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentVersion":{
            "type":"integer",
            "description":"The version of the incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictingAccPointName":{
            "maxLength":256,
            "type":"string",
            "description":"The name of an access point that is in conflict with the access point identified by the AccessPointName attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentInformationCodes":{
            "maxLength":4000,
            "type":"string",
            "description":"The unique codes that correlate to the incident information path value. These codes represent the job, duty, and privilege codes.",
            "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"
            }
        },
        "GroupingValue":{
            "maxLength":4000,
            "type":"string",
            "description":"For a transaction incident, Grouping Value reports the value that grouped result records have in common. For an access incident, Grouping Value is not used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GlobalUserName":{
            "maxLength":256,
            "type":"string",
            "description":"The unique global user name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlId":{
            "type":"integer",
            "description":"The unique identifier of the advanced control that generated the incident.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":19
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the advanced-control incident most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the advanced-control incident.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view or modify comments written about advanced control incidents.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-comments-item-response"
            }
        },
        "GlobalUserId":{
            "type":"integer",
            "description":"The unique identifier of the global user.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":19
            },
            "x-queryable":true
        },
        "IsIntraRoleViol":{
            "maxLength":1,
            "type":"string",
            "description":"Whether the incident is an \"intra-role\" conflict, which is defined as involving access points available within a single role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"The priority of the advanced-control incident.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":19
            },
            "x-queryable":true
        },
        "additionalInformations":{
            "title":"Flexfields",
            "type":"array",
            "description":"The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-additionalInformations-item-response"
            },
            "x-cardinality":"1"
        },
        "UserFirstName":{
            "maxLength":256,
            "type":"string",
            "description":"The first name of the user involved in the incident result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessPointType":{
            "maxLength":256,
            "type":"string",
            "description":"Whether the focal access point of an access incident is a privilege or a role. This does not apply to transaction incidents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSource":{
            "maxLength":256,
            "type":"string",
            "description":"The data source in which the incident occurred.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Role":{
            "maxLength":4000,
            "type":"string",
            "description":"The parent role in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessPointName":{
            "maxLength":256,
            "type":"string",
            "description":"The terminal access point in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionDate":{
            "type":"string",
            "description":"The date and time the advanced-control incident was revised.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-perspectives-item-response"
            }
        },
        "State":{
            "maxLength":30,
            "type":"string",
            "description":"The state of the advanced-control incident. Values include In Investigation, Approved, and Closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlType":{
            "type":"integer",
            "description":"The type of advanced control that generated the incident, access or transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":19
            }
        },
        "ClosedDate":{
            "type":"string",
            "description":"The date and time when the advanced-control incident was closed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":256,
            "type":"string",
            "description":"The unique identifier of the advanced-control incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Entitlement":{
            "maxLength":4000,
            "type":"string",
            "description":"The entitlement, if any, to which the focal access point of an access incident belongs. This does not apply to transaction incidents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who closed the advanced-control incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the advanced-control incident was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.

Show Source

• Array of: object advancedControls-incidents-additionalInformations-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-additionalInformations-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view or modify comments written about advanced control incidents.

Show Source

• Array of: object advancedControls-incidents-comments-item-response

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view or modify comments written about advanced control incidents.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-comments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.

Show Source

• Array of: object advancedControls-incidents-perspectives-item-response

{
    "title":"Perspectives",
    "type":"array",
    "description":"The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-perspectives-item-response"
    }
}

Nested Schema : advancedControls-incidents-additionalInformations-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The segment that appears in a flexfield associated to the advanced control only in a defined context.
• Id: string
  Maximum Length: 255

  The unique identifier of a flexfield associated to the advanced control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of a flexfield associated to the advanced control.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The segment that appears in a flexfield associated to the advanced control only in a defined context.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : advancedControls-incidents-comments-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the advanced-control comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the advanced-control comment was created.
• Delegated: string
  Default Value: N

  The flag indicating that the advanced-control comment was delegated.
• Id: integer
  The unique identifier of the advanced-control comment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the advanced-control comment was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who updated the advanced-control comment most recently.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The text of the advanced-control comment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the advanced-control comment most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the advanced-control comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the advanced-control comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":2000,
            "type":"string",
            "description":"The text of the advanced-control comment.",
            "nullable":false,
            "x-queryable":true
        },
        "Delegated":{
            "type":"string",
            "description":"The flag indicating that the advanced-control comment was delegated.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the advanced-control comment.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the advanced-control comment was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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 : advancedControls-incidents-perspectives-item-response

Type: object

Show Source

• IncidentId: string
  The unique identifier of the advanced control incident the perspective value is assigned to.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 150

  The name of the perspective value assigned to the advanced control.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.
• TreeId: integer
  The unique identifier of the perspective hierarchy.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreeId":{
            "type":"integer",
            "description":"The unique identifier of the perspective hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/advancedControls-incidents-perspectives-perspectives-item-response"
            }
        },
        "IncidentId":{
            "type":"string",
            "description":"The unique identifier of the advanced control incident the perspective value is assigned to.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the perspective value assigned to the advanced control.",
            "nullable":false,
            "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 : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.

Show Source

• Array of: object advancedControls-incidents-perspectives-perspectives-item-response

{
    "title":"Perspectives",
    "type":"array",
    "description":"The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.",
    "items":{
        "$ref":"#/components/schemas/advancedControls-incidents-perspectives-perspectives-item-response"
    }
}

Nested Schema : advancedControls-incidents-perspectives-perspectives-item-response

Type: object

Show Source

• IncidentId: string
  The unique identifier of the advanced control incident the perspective value is assigned to.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 150

  The name of the perspective value assigned to the advanced control.
• PerspItemId: integer
  The unique identifier of the perspective value assigned to the advanced control.
• TreeId: integer
  The unique identifier of the perspective hierarchy.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreeId":{
            "type":"integer",
            "description":"The unique identifier of the perspective hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "IncidentId":{
            "type":"string",
            "description":"The unique identifier of the advanced control incident the perspective value is assigned to.",
            "nullable":true,
            "x-queryable":true
        },
        "PerspItemId":{
            "type":"integer",
            "description":"The unique identifier of the perspective value assigned to the advanced control.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the perspective value assigned to the advanced control.",
            "nullable":false,
            "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

additionalInformations

Operation: /fscmRestApi/resources/11.13.18.05/advancedControls/{Id}/child/incidents/{Id4}/child/additionalInformations

Parameters:

• Id: $request.path.Id
• Id4: $request.path.Id4

The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.

comments

Operation: /fscmRestApi/resources/11.13.18.05/advancedControls/{Id}/child/incidents/{Id4}/child/comments

Parameters:

• Id: $request.path.Id
• Id4: $request.path.Id4

The comments resource is used to view or modify comments written about advanced control incidents.

perspectives

Operation: /fscmRestApi/resources/11.13.18.05/advancedControls/{Id}/child/incidents/{Id4}/child/perspectives

Parameters:

• Id: $request.path.Id
• Id4: $request.path.Id4

The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.

Back to Top

Examples

Example 1

The following example shows how to update an incident by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A18

Example Request Payload

The following example shows the contents of the request body in JSON format:

{  
	"Status": "ACCEPTED"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{  
	"ResultGroup": null,
	"GroupingValue": null,
	"IncidentInformation": "Payables Invoice.Amount: 50.0",
	"AccessPointName": null,
	"ClosedBy": null,
	"ClosedDate": null,
	"ConflictingAccPointName": null,
	"AccessPointType": null,
	"CreatedBy": "APPLICATION_CONTROL_MANAGER",
	"CreationDate": "2019-12-19T10:17:13.989-08:00",
	"DataSource": "Oracle Cloud",
	"Entitlement": null,
	"GlobalUserId": 0,
	"GlobalUserName": null,
	"UserFirstName": null,
	"ControlId": 10011,
	"Id": "10011:18",
	"IncidentVersion": 13,
	"IsIntraRoleViol": null,
	"UserLastName": null,
	"LastUpdateDate": "2020-02-03T11:22:32-08:00",
	"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
	"Priority": 3,
	"RevisionDate": "2019-12-19T10:17:18-08:00",
	"Role": null,
	"ConflictingRoles": null,
	"State": "IN_INVESTIGATION",
	"Status": "ACCEPTED",
	"ControlType": 174,
	"ControlName": "Payable invoice: amount between 50 and 70",
	"ResultInvestigator": "All Eligible Users",
	"links": [    
		{      
			"rel": "self",
			"href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011%3A18",
			"name": "incidents",
			"kind": "item"    
		},
		...
	] 
}

Example 2

The following example shows how to mass update incidents by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.batch+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05

Example Request Body

The following example shows the contents of the request body in JSON format:

{
"parts": [
	{
	"id": "part1",
	"path": "/advancedControls/10011/child/incidents/10011:18",
	"operation": "update",
	"payload": 
		{
		"Status": "RESOLVED"
		}
	},
	{
	"id": "part2",
	"path": "/advancedControls/10011/child/incidents/10011:101",
	"operation": "update",
	"payload": 
		{
		"Status": "ASSIGNED"
		}
	}
  ]
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
	"parts": [
	{
		"id": "part1",
		"path": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011:18",
		"operation": "update",
		"payload": 
		{
			"ResultGroup": null,
			"GroupingValue": null,
			"IncidentInformation": "Payables Invoice.Amount: 50.0",
			"AccessPointName": null,
			"ClosedBy": null,
			"ClosedDate": null,
			"ConflictingAccPointName": null,
			"AccessPointType": null,
			"CreatedBy": "APPLICATION_CONTROL_MANAGER",
			"CreationDate": "2019-12-19T10:17:13.989-08:00",
			"DataSource": "Oracle Cloud",
			"Entitlement": null,
			"GlobalUserId": 0,
			"GlobalUserName": null,
			"UserFirstName": null,
			"ControlId": 10011,
			"Id": "10011:18",
			"IncidentVersion": 23,
			"IsIntraRoleViol": null,
			"UserLastName": null,
			"LastUpdateDate": "2020-03-03T12:21:00-08:00",
			"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
			"Priority": 3,
			"RevisionDate": "2019-12-19T10:17:18-08:00",
			"Role": null,
			"ControlType": 174,
			"HasEdit": "Y",
			"ControlName": "JUNIT_TEST_CONTROL_DO_NOT_TOUCH",
			"ResultInvestigator": "All Eligible Users",
			"links": [...]
		}
	},
	{
		"id": "part2",
		"path": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011/child/incidents/10011:101",
		"operation": "update",
		"payload": 
		{
			"ResultGroup": null,
			"GroupingValue": null,
			"IncidentInformation": "Payables Invoice.Amount: 56.0",
			"AccessPointName": null,
			"ClosedBy": null,
			"ClosedDate": null,
			"ConflictingAccPointName": null,
			"AccessPointType": null,
			"CreatedBy": "APPLICATION_CONTROL_MANAGER",
			"CreationDate": "2019-12-19T10:17:13.990-08:00",
			"DataSource": "Oracle Cloud",
			"Entitlement": null,
			"GlobalUserId": 0,
			"GlobalUserName": null,
			"UserFirstName": null,
			"ControlId": 10011,
			"Id": "10011:101",
			"IncidentVersion": 5,
			"IsIntraRoleViol": null,
			"UserLastName": null,
			"LastUpdateDate": "2020-03-03T12:26:22-08:00",
			"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
			"Priority": 1,
			"RevisionDate": "2019-12-19T10:17:18-08:00",
			"Role": null,
			"ConflictingRoles": null,
			"State": "IN_INVESTIGATION",
			"Status": "ASSIGNED",
			"ControlType": 174,
			"HasEdit": "Y",
			"ControlName": "JUNIT_TEST_CONTROL_DO_NOT_TOUCH",
			"ResultInvestigator": "All Eligible Users",
			"links": [...]
        }
    }
  ]
}

Back to Top