Jump to

• Request
• Response

Update a period

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorCalendars-item

Type: object

Show Source

• AccountingPeriod(optional): string
  Title: Period

  Maximum Length: 8

  The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the calendar. 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 accounting period using the Create Periods button on the Monthly Accounting Calendar page.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time the accounting period was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• OpenCloseFlag(optional): string
  Title: Status

  Maximum Length: 1

  Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.
• PeriodEndDate(optional): string(date-time)
  Title: End Date

  The last day of the accounting period.
• PeriodStartDate(optional): string(date-time)
  Title: Start Date

  The first day of the accounting period.

{
    "properties":{
        "AccountingPeriod":{
            "maxLength":8,
            "type":"string",
            "description":"The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.",
            "title":"Period"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the calendar. 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 accounting period using the Create Periods button on the Monthly Accounting Calendar page.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the accounting period was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the accounting period was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting period.",
            "title":"Last Updated By"
        },
        "OpenCloseFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.",
            "title":"Status"
        },
        "PeriodEndDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day of the accounting period.",
            "title":"End Date"
        },
        "PeriodStartDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day of the accounting period.",
            "title":"Start 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 : publicSectorCalendars-item

Type: object

Show Source

• AccountingPeriod(optional): string
  Title: Period

  Maximum Length: 8

  The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the calendar. 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 accounting period using the Create Periods button on the Monthly Accounting Calendar page.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time the accounting period was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• OpenCloseFlag(optional): string
  Title: Status

  Maximum Length: 1

  Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.
• PeriodEndDate(optional): string(date-time)
  Title: End Date

  The last day of the accounting period.
• PeriodStartDate(optional): string(date-time)
  Title: Start Date

  The first day of the accounting period.

{
    "properties":{
        "AccountingPeriod":{
            "maxLength":8,
            "type":"string",
            "description":"The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.",
            "title":"Period"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the calendar. 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 accounting period using the Create Periods button on the Monthly Accounting Calendar page.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the accounting period was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the accounting period was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting period.",
            "title":"Last Updated By"
        },
        "OpenCloseFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.",
            "title":"Status"
        },
        "PeriodEndDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day of the accounting period.",
            "title":"End Date"
        },
        "PeriodStartDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day of the accounting period.",
            "title":"Start 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