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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPrograms-item
Type:
Show Source
object
-
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.
Nested Schema : link
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPrograms-item
Type:
Show Source
object
-
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.
Nested Schema : link
Type:
Show Source
object
-
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.