Jump to

• Request
• Response

Update a plan review decision

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorPlanReviewDecisionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- SystemStatus and AgencyId ---for the Plan Review Decisions resource and used to uniquely identify an instance of Plan Review Decisions. The client should not generate the hash key value. Instead, the client should query on the Plan Review Decisions collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Review Decisions.
  
  For example: publicSectorPlanReviewDecisions?q=SystemStatus=<value1>;AgencyId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorPlanReviewDecisions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this plan review decision applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the plan review decision.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the plan review decision was created.
• DecisionStatus(optional): string
  Maximum Length: 35

  The name of the decision status.
• DeletedFlag(optional): boolean
  Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The value that will be displayed for a plan review decision in a plan review cycle.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the decision status is enabled for plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the plan review decision was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the plan review decision.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SystemStatus(optional): string
  Maximum Length: 15

  The unique identifier for the plan review decision.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review decision applies."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan review decision.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review decision was created.",
            "title":"Creation Date"
        },
        "DecisionStatus":{
            "maxLength":35,
            "type":"string",
            "description":"The name of the decision status."
        },
        "DeletedFlag":{
            "type":"boolean",
            "description":"Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The value that will be displayed for a plan review decision in a plan review cycle.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the decision status is enabled for plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true.  This attribute can only be changed for a decision status of Approved with Comments.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review decision was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the plan review decision.",
            "title":"Last Updated By"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the plan review decision."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPlanReviewDecisions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this plan review decision applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the plan review decision.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the plan review decision was created.
• DecisionStatus(optional): string
  Maximum Length: 35

  The name of the decision status.
• DeletedFlag(optional): boolean
  Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The value that will be displayed for a plan review decision in a plan review cycle.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the decision status is enabled for plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the plan review decision was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the plan review decision.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SystemStatus(optional): string
  Maximum Length: 15

  The unique identifier for the plan review decision.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review decision applies."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan review decision.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review decision was created.",
            "title":"Creation Date"
        },
        "DecisionStatus":{
            "maxLength":35,
            "type":"string",
            "description":"The name of the decision status."
        },
        "DeletedFlag":{
            "type":"boolean",
            "description":"Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The value that will be displayed for a plan review decision in a plan review cycle.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the decision status is enabled for plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true.  This attribute can only be changed for a decision status of Approved with Comments.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review decision was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the plan review decision.",
            "title":"Last Updated By"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the plan review decision."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top