Jump to

• Request
• Response

Update a program

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPrograms/{publicSectorProgramsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorPrograms-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the program. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the program was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

  The date and time the program was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the program.
• links(optional): array Items
  Title: Items

  Link Relations
• ProgramId(optional): string
  Title: Program

  Maximum Length: 30

  The unique identifier of the program. Identifies a set of activities performed by an agency to accomplish a specific goal which is associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the program. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the program.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the program was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the program.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the program was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the program.",
            "title":"Last Updated By"
        },
        "ProgramId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the program. Identifies a set of activities performed by an agency to accomplish a specific goal which is associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Program"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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 : publicSectorPrograms-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the program. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the program was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

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

  The date and time the program was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the program.
• links(optional): array Items
  Title: Items

  Link Relations
• ProgramId(optional): string
  Title: Program

  Maximum Length: 30

  The unique identifier of the program. Identifies a set of activities performed by an agency to accomplish a specific goal which is associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the program. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the program.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the program was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the program.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the program was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the program.",
            "title":"Last Updated By"
        },
        "ProgramId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the program. Identifies a set of activities performed by an agency to accomplish a specific goal which is associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Program"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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