Jump to

• Request
• Response

Update a plan reviewer department

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorPlanReviewerDepartments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this plan reviewer department applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time when the plan reviewer department was created.
• Department(optional): string
  Title: Department

  Maximum Length: 25

  The value that will be displayed for a plan reviewer department. This value is user-defined.
• DepartmentId(optional): string
  Title: Department ID

  Maximum Length: 30

  The unique identifier for a plan reviewer department.
• DepartmentLeadId(optional): integer(int64)
  Title: Department Lead

  The unique identifier for the plan reviewer department lead.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The long description value for a plan reviewer department.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer department applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan reviewer department.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer department was created.",
            "title":"Creation Date"
        },
        "Department":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for a plan reviewer department. This value is user-defined.",
            "title":"Department"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a plan reviewer department.",
            "title":"Department ID"
        },
        "DepartmentLeadId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the plan reviewer department lead.",
            "title":"Department Lead"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The long description value for a plan reviewer department.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer department was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the plan reviewer department.",
            "title":"Last Updated By"
        },
        "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 : publicSectorPlanReviewerDepartments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this plan reviewer department applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time when the plan reviewer department was created.
• Department(optional): string
  Title: Department

  Maximum Length: 25

  The value that will be displayed for a plan reviewer department. This value is user-defined.
• DepartmentId(optional): string
  Title: Department ID

  Maximum Length: 30

  The unique identifier for a plan reviewer department.
• DepartmentLeadId(optional): integer(int64)
  Title: Department Lead

  The unique identifier for the plan reviewer department lead.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The long description value for a plan reviewer department.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer department applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan reviewer department.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer department was created.",
            "title":"Creation Date"
        },
        "Department":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for a plan reviewer department. This value is user-defined.",
            "title":"Department"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a plan reviewer department.",
            "title":"Department ID"
        },
        "DepartmentLeadId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the plan reviewer department lead.",
            "title":"Department Lead"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The long description value for a plan reviewer department.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer department was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the plan reviewer department.",
            "title":"Last Updated By"
        },
        "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