Jump to

• Request
• Response
• Examples

Update a process

patch

/fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}

Request

Path Parameters

• ProcessId(required): integer(int64)
  The unique identifier of the process.

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

• actionItems: array Action Items
  Title: Action Items

  The action items resource is used to view or modify action items to be completed in conjunction with processes.
• additionalInformation: array Flexfields
  Title: Flexfields

  The flexfields resource is used to view or modify information added to process definitions in flexfields.
• AssessmentFlag: boolean
  Title: Assessment Testing

  Maximum Length: 1

  Default Value: false

  Identifies if the process is in scope for an assessment.
• AuditTestingFlag: boolean
  Title: Audit Testing

  Maximum Length: 1

  Default Value: false

  Identifies if the process is in scope for audit testing.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about processes.
• DetailedDescription: string (byte)
  Title: Description

  The description of the process.
• Name: string
  Title: Name

  Maximum Length: 150

  The name of the process.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.
• relatedRisks: array Related Risks
  Title: Related Risks

  The related risks resource is used to view records of risks that may impact processes.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ACTIVE

  The status of the process: ACTIVE or INACTIVE.
• Type: string
  Title: Type

  Maximum Length: 30

  One in a set of user-defined values that may be selected for the process.

{
    "type":"object",
    "properties":{
        "AssessmentFlag":{
            "title":"Assessment Testing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies if the process is in scope for an assessment.",
            "nullable":false,
            "default":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the process: ACTIVE or INACTIVE.",
            "nullable":false,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "additionalInformation":{
            "title":"Flexfields",
            "type":"array",
            "description":"The flexfields resource is used to view or modify information added to process definitions in flexfields.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-additionalInformation-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"One in a set of user-defined values that may be selected for the process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "comments":{
            "title":"Comments",
            "type":"array",
            "description":"The comments resource is used to view or modify comments written about processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-comments-item-patch-request"
            }
        },
        "actionItems":{
            "title":"Action Items",
            "type":"array",
            "description":"The action items resource is used to view or modify action items to be completed in conjunction with processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-actionItems-item-patch-request"
            }
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-perspectives-item-patch-request"
            }
        },
        "AuditTestingFlag":{
            "title":"Audit Testing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies if the process is in scope for audit testing.",
            "nullable":false,
            "default":false
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the process.",
            "format":"byte",
            "nullable":true
        },
        "relatedRisks":{
            "title":"Related Risks",
            "type":"array",
            "description":"The related risks resource is used to view records of risks that may impact processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-relatedRisks-item-patch-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the process.",
            "nullable":false
        }
    }
}

Nested Schema : Action Items

Type: array

Title: Action Items

The action items resource is used to view or modify action items to be completed in conjunction with processes.

Show Source

• Array of: object frcProcesses-actionItems-item-patch-request

{
    "title":"Action Items",
    "type":"array",
    "description":"The action items resource is used to view or modify action items to be completed in conjunction with processes.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-actionItems-item-patch-request"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The flexfields resource is used to view or modify information added to process definitions in flexfields.

Show Source

• Array of: object frcProcesses-additionalInformation-item-patch-request

{
    "title":"Flexfields",
    "type":"array",
    "description":"The flexfields resource is used to view or modify information added to process definitions in flexfields.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-additionalInformation-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 processes.

Show Source

• Array of: object frcProcesses-comments-item-patch-request

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

Nested Schema : Perspectives

Type: array

Title: Perspectives

The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.

Show Source

• Array of: object frcProcesses-perspectives-item-patch-request

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

Nested Schema : Related Risks

Type: array

Title: Related Risks

The related risks resource is used to view records of risks that may impact processes.

Show Source

• Array of: object frcProcesses-relatedRisks-item-patch-request

{
    "title":"Related Risks",
    "type":"array",
    "description":"The related risks resource is used to view records of risks that may impact processes.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-relatedRisks-item-patch-request"
    }
}

Nested Schema : frcProcesses-actionItems-item-patch-request

Type: object

Show Source

• ActionId: integer (int64)
  Title: Record ID

  The unique identifier of the action item.
• CompletedDate: string (date)
  Title: Completion Date

  The date and time the action item was marked as complete.
• DetailedDescription: string (byte)
  Title: Instructions

  The description of the action item. This is a CLOB attribute.
• DueDate: string (date-time)
  Title: Due Date

  The date when the action item is due.
• EstimatedCompletionDate: string (date-time)
  Title: Target Completion Date

  The target completion date of the action item.
• Name: string
  Title: Name

  Maximum Length: 150

  The name of the action item.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  The priority of the action item.
• ProcessId: integer (int64)
  The unique identifier of the process the action item is related to.
• ProgressCode: string
  Title: Progress

  Maximum Length: 30

  A value indicating progress toward completion of the action item: Assigned, Blocked, Delayed, or On Target.

{
    "type":"object",
    "properties":{
        "EstimatedCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"The target completion date of the action item.",
            "format":"date-time",
            "nullable":true
        },
        "ActionId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the action item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_PROC_ACTITEM_S"
            }
        },
        "ProgressCode":{
            "title":"Progress",
            "maxLength":"30",
            "type":"string",
            "description":"A value indicating progress toward completion of the action item: Assigned, Blocked, Delayed, or On Target.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The priority of the action item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process the action item is related to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the action item is due.",
            "format":"date-time",
            "nullable":false
        },
        "DetailedDescription":{
            "title":"Instructions",
            "type":"string",
            "description":"The description of the action item. This is a CLOB attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time the action item was marked as complete.",
            "format":"date",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the action item.",
            "nullable":false
        }
    }
}

Nested Schema : frcProcesses-additionalInformation-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context of the flexfields associated to the process.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The display value of the context of the flexfields associated to the process.
• ProcessId: integer (int64)
  Title: Record ID

  The unique identifier of the process associated to the flexfield.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the process associated to the flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_PROC_PROCESS_S"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display value of the context of the flexfields associated to the process.",
            "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 of the flexfields associated to the process.",
            "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 : frcProcesses-comments-item-patch-request

Type: object

Show Source

• Id: integer
  The unique identifier of the comment on the process.
• UserComment: string
  Title: Comment

  Maximum Length: 2000

  The comment made on the process.

{
    "type":"object",
    "properties":{
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The comment made on the process.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the comment on the process.",
            "nullable":false,
            "x-hints":{
                "GRC::SEQUENCE_NAME":"GRC_COMMENT_S"
            }
        }
    }
}

Nested Schema : frcProcesses-perspectives-item-patch-request

Type: object

Show Source

• PerspItemId: integer (int64)
  The unique identifier of the perspective value assigned to the process.
• ProcessId: integer (int64)
  The unique identifier of the process.

{
    "type":"object",
    "properties":{
        "PerspItemId":{
            "type":"integer",
            "description":"The unique identifier of the perspective value assigned to the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : frcProcesses-relatedRisks-item-patch-request

Type: object

Show Source

• ProcessId: integer (int64)
  The unique identifier of the process the risk is related to.
• RiskId: integer (int64)
  The unique identifier of the risk.

{
    "type":"object",
    "properties":{
        "RiskId":{
            "type":"integer",
            "description":"The unique identifier of the risk.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process the risk is related to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• actionItems: array Action Items
  Title: Action Items

  The action items resource is used to view or modify action items to be completed in conjunction with processes.
• additionalInformation: array Flexfields
  Title: Flexfields

  The flexfields resource is used to view or modify information added to process definitions in flexfields.
• ApprovedBy: string
  Title: Last Approved By

  Read Only: true

  Maximum Length: 64

  The user who approved the process.
• ApprovedDate: string (date-time)
  Title: Approved Date

  Read Only: true

  The date and time the process was approved.
• AssessmentFlag: boolean
  Title: Assessment Testing

  Maximum Length: 1

  Default Value: false

  Identifies if the process is in scope for an assessment.
• AuditTestingFlag: boolean
  Title: Audit Testing

  Maximum Length: 1

  Default Value: false

  Identifies if the process is in scope for audit testing.
• comments: array Comments
  Title: Comments

  The comments resource is used to view or modify comments written about processes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time the process was created.
• DetailedDescription: string (byte)
  Title: Description

  The description of the process.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the process was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who most recently updated the process.
• links: array Links
  Title: Links

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

  Maximum Length: 150

  The name of the process.
• perspectives: array Perspectives
  Title: Perspectives

  The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.
• ProcessId: integer (int64)
  Title: Record ID

  Read Only: true

  The unique identifier of the process.
• relatedRisks: array Related Risks
  Title: Related Risks

  The related risks resource is used to view records of risks that may impact processes.
• ReviewedBy: string
  Title: Last Reviewed By

  Read Only: true

  Maximum Length: 64

  The user who reviewed the process.
• ReviewedDate: string (date-time)
  Title: Reviewed Date

  Read Only: true

  The date and time the process was reviewed.
• ReviewStartDate: string (date-time)
  Title: Reviewed Date

  Read Only: true

  The date and time when the process review was started.
• RevisionDate: string (date-time)
  Title: Revision Date

  Read Only: true

  The date when the process was revised.
• RevisionNumber: integer (int32)
  Title: Revision Number

  Read Only: true

  Default Value: 1

  The revision of the process.
• StateCode: string
  Title: State

  Read Only: true

  Maximum Length: 30

  Default Value: NEW

  The state of the process.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ACTIVE

  The status of the process: ACTIVE or INACTIVE.
• TotalRevisions: integer (int32)
  Read Only: true

  The total number of revisions for the process.
• Type: string
  Title: Type

  Maximum Length: 30

  One in a set of user-defined values that may be selected for the process.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the process was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewedDate":{
            "title":"Reviewed Date",
            "type":"string",
            "description":"The date and time the process was reviewed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "actionItems":{
            "title":"Action Items",
            "type":"array",
            "description":"The action items resource is used to view or modify action items to be completed in conjunction with processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-actionItems-item-response"
            }
        },
        "AuditTestingFlag":{
            "title":"Audit Testing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies if the process is in scope for audit testing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the process.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReviewedBy":{
            "title":"Last Reviewed By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who reviewed the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DetailedDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the process.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who most recently updated the process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the process: ACTIVE or INACTIVE.",
            "nullable":false,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "additionalInformation":{
            "title":"Flexfields",
            "type":"array",
            "description":"The flexfields resource is used to view or modify information added to process definitions in flexfields.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-additionalInformation-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the process.",
            "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 processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-comments-item-response"
            }
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time the process was approved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCode":{
            "title":"State",
            "maxLength":"30",
            "type":"string",
            "description":"The state of the process.",
            "nullable":false,
            "readOnly":true,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevisionNumber":{
            "title":"Revision Number",
            "type":"integer",
            "description":"The revision of the process.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "relatedRisks":{
            "title":"Related Risks",
            "type":"array",
            "description":"The related risks resource is used to view records of risks that may impact processes.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-relatedRisks-item-response"
            }
        },
        "ReviewStartDate":{
            "title":"Reviewed Date",
            "type":"string",
            "description":"The date and time when the process review was started.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentFlag":{
            "title":"Assessment Testing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies if the process is in scope for an assessment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "RevisionDate":{
            "title":"Revision Date",
            "type":"string",
            "description":"The date when the process was revised.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"One in a set of user-defined values that may be selected for the process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "perspectives":{
            "title":"Perspectives",
            "type":"array",
            "description":"The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.",
            "items":{
                "$ref":"#/components/schemas/frcProcesses-perspectives-item-response"
            }
        },
        "ApprovedBy":{
            "title":"Last Approved By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRevisions":{
            "type":"integer",
            "description":"The total number of revisions for the process.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ProcessId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the process.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_PROC_PROCESS_S"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the process was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Action Items

Type: array

Title: Action Items

The action items resource is used to view or modify action items to be completed in conjunction with processes.

Show Source

• Array of: object frcProcesses-actionItems-item-response

{
    "title":"Action Items",
    "type":"array",
    "description":"The action items resource is used to view or modify action items to be completed in conjunction with processes.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-actionItems-item-response"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The flexfields resource is used to view or modify information added to process definitions in flexfields.

Show Source

• Array of: object frcProcesses-additionalInformation-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The flexfields resource is used to view or modify information added to process definitions in flexfields.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-additionalInformation-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Comments

Type: array

Title: Comments

The comments resource is used to view or modify comments written about processes.

Show Source

• Array of: object frcProcesses-comments-item-response

{
    "title":"Comments",
    "type":"array",
    "description":"The comments resource is used to view or modify comments written about processes.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-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 perspective values assigned to processes or to modify those assignments.

Show Source

• Array of: object frcProcesses-perspectives-item-response

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

Nested Schema : Related Risks

Type: array

Title: Related Risks

The related risks resource is used to view records of risks that may impact processes.

Show Source

• Array of: object frcProcesses-relatedRisks-item-response

{
    "title":"Related Risks",
    "type":"array",
    "description":"The related risks resource is used to view records of risks that may impact processes.",
    "items":{
        "$ref":"#/components/schemas/frcProcesses-relatedRisks-item-response"
    }
}

Nested Schema : frcProcesses-actionItems-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Title: Record ID

  The unique identifier of the action item.
• CompletedDate: string (date)
  Title: Completion Date

  The date and time the action item was marked as complete.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the action item.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the action item was created.
• DetailedDescription: string (byte)
  Title: Instructions

  The description of the action item. This is a CLOB attribute.
• DueDate: string (date-time)
  Title: Due Date

  The date when the action item is due.
• EstimatedCompletionDate: string (date-time)
  Title: Target Completion Date

  The target completion date of the action item.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the action item was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who most recently updated the action item.
• links: array Links
  Title: Links

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

  Maximum Length: 150

  The name of the action item.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  The priority of the action item.
• ProcessId: integer (int64)
  The unique identifier of the process the action item is related to.
• ProgressCode: string
  Title: Progress

  Maximum Length: 30

  A value indicating progress toward completion of the action item: Assigned, Blocked, Delayed, or On Target.
• StartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when the action item started.
• StateCode: string
  Title: State

  Read Only: true

  Maximum Length: 30

  Default Value: ACTIVE

  The state of the action item.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who most recently updated the action item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"The target completion date of the action item.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the action item 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 action item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The priority of the action item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StateCode":{
            "title":"State",
            "maxLength":"30",
            "type":"string",
            "description":"The state of the action item.",
            "nullable":false,
            "readOnly":true,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompletedDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time the action item was marked as complete.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the action item.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action item started.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the action item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_PROC_ACTITEM_S"
            },
            "x-queryable":true
        },
        "ProgressCode":{
            "title":"Progress",
            "maxLength":"30",
            "type":"string",
            "description":"A value indicating progress toward completion of the action item: Assigned, Blocked, Delayed, or On Target.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process the action item is related to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the action item is due.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DetailedDescription":{
            "title":"Instructions",
            "type":"string",
            "description":"The description of the action item. This is a CLOB attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the action item 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 : 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 : frcProcesses-additionalInformation-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The context of the flexfields associated to the process.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The display value of the context of the flexfields associated to the process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessId: integer (int64)
  Title: Record ID

  The unique identifier of the process associated to the flexfield.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier of the process associated to the flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GRC_PROC_PROCESS_S"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display value of the context of the flexfields associated to the process.",
            "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 of the flexfields associated to the process.",
            "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 : frcProcesses-comments-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time the comment was created.
• Id: integer
  The unique identifier of the comment on the process.
• links: array Links
  Title: Links

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

  Maximum Length: 2000

  The comment made on the process.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the comment on the process.",
            "nullable":false,
            "x-hints":{
                "GRC::SEQUENCE_NAME":"GRC_COMMENT_S"
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comment",
            "maxLength":"2000",
            "type":"string",
            "description":"The comment made on the process.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : frcProcesses-perspectives-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Maximum Length: 150

  The name of the perspective item assigned to the process.
• PerspItemId: integer (int64)
  The unique identifier of the perspective value assigned to the process.
• ProcessId: integer (int64)
  The unique identifier of the process.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of the perspective item assigned to the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PerspItemId":{
            "type":"integer",
            "description":"The unique identifier of the perspective value assigned to the process.",
            "format":"int64",
            "nullable":false,
            "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 : frcProcesses-relatedRisks-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessId: integer (int64)
  The unique identifier of the process the risk is related to.
• RiskId: integer (int64)
  The unique identifier of the risk.

{
    "type":"object",
    "properties":{
        "RiskId":{
            "type":"integer",
            "description":"The unique identifier of the risk.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"The unique identifier of the process the risk is related to.",
            "format":"int64",
            "nullable":false,
            "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"
    }
}

Links

actionItems

Operation: /fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}/child/actionItems

Parameters:

• ProcessId: $request.path.ProcessId

The action items resource is used to view or modify action items to be completed in conjunction with processes.

additionalInformation

Operation: /fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}/child/additionalInformation

Parameters:

• ProcessId: $request.path.ProcessId

The flexfields resource is used to view or modify information added to process definitions in flexfields.

comments

Operation: /fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}/child/comments

Parameters:

• ProcessId: $request.path.ProcessId

The comments resource is used to view or modify comments written about processes.

perspectives

Operation: /fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}/child/perspectives

Parameters:

• ProcessId: $request.path.ProcessId

The perspectives resource is used to view perspective values assigned to processes or to modify those assignments.

relatedRisks

Operation: /fscmRestApi/resources/11.13.18.05/frcProcesses/{ProcessId}/child/relatedRisks

Parameters:

• ProcessId: $request.path.ProcessId

The related risks resource is used to view records of risks that may impact processes.

Back to Top

Examples

The following example shows how to update a process 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/frcProcesses/43019

Example Request Body

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

{
    "Name": "Process Renamed"
}

Example Response Body

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

{
    "ApprovedBy": null,
    "ApprovedDate": null,
    "AssessmentFlag": false,
    "AuditTestingFlag": false,
    "CreatedBy": "FRC_WSUSER",
    "CreationDate": "2021-01-06T16:44:54+00:00",
    "LastUpdateDate": "2021-01-06T17:09:53.007+00:00",
    "LastUpdatedBy": "FRC_WSUSER",
    "Name": "Process Renamed",
    "ProcessId": 43019,
    "ReviewStartDate": null,
    "ReviewedBy": null,
    "ReviewedDate": null,
    "RevisionDate": "2021-01-06T16:44:54.460+00:00",
    "RevisionNumber": 1,
    "StateCode": "NEW",
    "Status": "ACTIVE",
    "TotalRevisions": 1,
    "Type": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019",
            "name": "frcProcesses",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019",
            "name": "frcProcesses",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/actionItems",
            "name": "actionItems",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/additionalInformation",
            "name": "additionalInformation",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/comments",
            "name": "comments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/perspectives",
            "name": "perspectives",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/child/relatedRisks",
            "name": "relatedRisks",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcProcesses/43019/enclosure/DetailedDescription",
            "name": "DetailedDescription",
            "kind": "other"
        }
    ]
}

Back to Top