Jump to

• Request
• Response
• Examples

Update one sustainability period

patch

/fscmRestApi/resources/11.13.18.05/sustainabilityPeriods/{PeriodId}

Request

Path Parameters

• PeriodId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PeriodStatus: string
  Title: Period Status

  Maximum Length: 255

  Status of the sustainability period.
• PeriodStatusCode: string
  Title: Period Status Code

  Maximum Length: 100

  Code for the sustainability period status.

{
    "type":"object",
    "properties":{
        "PeriodStatusCode":{
            "title":"Period Status Code",
            "maxLength":100,
            "type":"string",
            "description":"Code for the sustainability period status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodStatus":{
            "title":"Period Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the sustainability period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodStatusCode"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : sustainabilityPeriods-item-response

Type: object

Show Source

• AdjustmentPeriod: string
  Title: Adjustment Period

  Maximum Length: 1

  Indicator for the adjustment period.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  Date when the accounting period ends.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User login by whom the record was last updated.
• Ledger: string
  Title: Sustainability Ledger

  Read Only: true

  Maximum Length: 255

  Unique name of the sustainability ledger.
• LedgerId: integer (int64)
  Title: Sustainability Ledger ID

  Unique identifier of the sustainability ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodId: integer (int64)
  Title: Period ID

  Unique identifier of the sustainability period.
• PeriodName: string
  Title: Period

  Maximum Length: 15

  System generated name for the accounting period.
• PeriodNumber: integer (int64)
  Title: Period Number

  Number indicating a period within an accounting calendar year.
• PeriodStatus: string
  Title: Period Status

  Maximum Length: 255

  Status of the sustainability period.
• PeriodStatusCode: string
  Title: Period Status Code

  Maximum Length: 100

  Code for the sustainability period status.
• PeriodType: string
  Title: Period Type

  Maximum Length: 15

  Accounting period type. Examples are Weekly, Monthly, Quarterly.
• PeriodYear: integer (int32)
  Title: Period Year

  Accounting calendar year represented by a value such as 2023.
• StartDate: string (date)
  Title: Start Date

  Date when the accounting period begins.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User login by whom the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Period Type",
            "maxLength":15,
            "type":"string",
            "description":"Accounting period type. Examples are Weekly, Monthly, Quarterly.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodYear":{
            "title":"Period Year",
            "type":"integer",
            "description":"Accounting calendar year represented by a value such as 2023.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Ledger":{
            "title":"Sustainability Ledger",
            "maxLength":255,
            "type":"string",
            "description":"Unique name of the sustainability ledger.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentPeriod":{
            "title":"Adjustment Period",
            "maxLength":1,
            "type":"string",
            "description":"Indicator for the adjustment period.",
            "nullable":true,
            "x-queryable":true
        },
        "LedgerId":{
            "title":"Sustainability Ledger ID",
            "type":"integer",
            "description":"Unique identifier of the sustainability ledger.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"Unique identifier of the sustainability period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the accounting period ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the accounting period begins.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStatusCode":{
            "title":"Period Status Code",
            "maxLength":100,
            "type":"string",
            "description":"Code for the sustainability period status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodNumber":{
            "title":"Period Number",
            "type":"integer",
            "description":"Number indicating a period within an accounting calendar year.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":15,
            "type":"string",
            "description":"System generated name for the accounting period.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStatus":{
            "title":"Period Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the sustainability period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodStatusCode"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update one sustainability period.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sustainabilityPeriods/PeriodId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "PeriodStatus": "Closed"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "PeriodId": 300100608310743,
    "PeriodName": "Jun-23",
    "PeriodType": "MONTH6615409953",
    "PeriodYear": 2023,
    "PeriodNumber": 6,
    "StartDate": "2023-06-01",
    "EndDate": "2023-06-30",
    "PeriodStatusCode": "ORA_SUS_PERIOD_CLOSED",
    "LedgerId": 300100608267605,
    "AdjustmentPeriod": "N",
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2024-08-02T02:32:19.104+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2024-08-02T04:03:48+00:00",
    "PeriodStatus": "Closed",
    "Ledger": "Vision Corp Ledger",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityPeriods/300100608310743",
            "name": "sustainabilityPeriods",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityPeriods/300100608310743",
            "name": "sustainabilityPeriods",
            "kind": "item"
        }
    ]
}

Back to Top