Jump to

• Request
• Response

Update a budget execution control segment

patch

/fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments/{KeySegmentId}

Request

Path Parameters

• KeySegmentId(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=
• fedBudgetExecutionControlsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Federal Budget Execution Controls resource and used to uniquely identify an instance of Federal Budget Execution Controls. The client should not generate the hash key value. Instead, the client should query on the Federal Budget Execution Controls collection resource in order to navigate to a specific instance of Federal Budget Execution Controls to get the hash key.

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

• ControlBudgetTree: string
  Title: Tree

  Control budget tree of the budget execution control segment.
• ControlBudgetTreeLabel: string
  Title: Tree Label

  Control budget tree label of the budget execution control segment.
• ControlBudgetTreeVersion: string
  Title: Tree Version

  Control budget tree version of the budget execution control segment.
• ExistsOnParent: string
  Default Value: N

  Exists on parent attribute of the budget execution control segment.
• FilterTree: string
  Title: Filter Tree

  Filter tree of the budget execution control segment.
• FilterTreeValue: string
  Title: Filter Summary Value

  Filter tree value of the budget execution control segment.
• FilterTreeVersion: string
  Title: Filter Tree Version

  Filter tree version of the budget execution control segment.
• IsAccountSegment: string
  Default Value: N

  Account segment of the budget execution control segment.
• IsBalancingSegment: string
  Default Value: N

  Balancing segment of the budget execution control segment.
• SegmentCode: string
  Title: Segment Name

  Segment code of the budget execution control segment.
• SegmentName: string
  Maximum Length: 30

  Segment name of the budget execution control segment.
• SequenceNumber: integer (int32)
  Title: Sequence

  Sequence number of the budget execution control segment.
• SummaryControl: string
  Title: Summary Control

  Summary control of the budget execution control segment.

{
    "type":"object",
    "properties":{
        "ControlBudgetTree":{
            "title":"Tree",
            "type":"string",
            "description":"Control budget tree of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlBudgetTreeLabel":{
            "title":"Tree Label",
            "type":"string",
            "description":"Control budget tree label of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControlBudgetTreeVersion":{
            "title":"Tree Version",
            "type":"string",
            "description":"Control budget tree version of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExistsOnParent":{
            "type":"string",
            "description":"Exists on parent attribute of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FilterTree":{
            "title":"Filter Tree",
            "type":"string",
            "description":"Filter tree of the budget execution control segment.",
            "nullable":true,
            "x-queryable":false
        },
        "FilterTreeValue":{
            "title":"Filter Summary Value",
            "type":"string",
            "description":"Filter tree value of the budget execution control segment.",
            "nullable":true
        },
        "FilterTreeVersion":{
            "title":"Filter Tree Version",
            "type":"string",
            "description":"Filter tree version of the budget execution control segment.",
            "nullable":true
        },
        "IsAccountSegment":{
            "type":"string",
            "description":"Account segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "IsBalancingSegment":{
            "type":"string",
            "description":"Balancing segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "SegmentCode":{
            "title":"Segment Name",
            "type":"string",
            "description":"Segment code of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SegmentName":{
            "maxLength":30,
            "type":"string",
            "description":"Segment name of the budget execution control segment.",
            "nullable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the budget execution control segment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "SummaryControl":{
            "title":"Summary Control",
            "type":"string",
            "description":"Summary control of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            }
        }
    }
}

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 : fedBudgetExecutionControls-fedBudgetControlSegments-item-response

Type: object

Show Source

• ControlBudgetTree: string
  Title: Tree

  Control budget tree of the budget execution control segment.
• ControlBudgetTreeLabel: string
  Title: Tree Label

  Control budget tree label of the budget execution control segment.
• ControlBudgetTreeVersion: string
  Title: Tree Version

  Control budget tree version of the budget execution control segment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• ExistsOnParent: string
  Default Value: N

  Exists on parent attribute of the budget execution control segment.
• FilterTree: string
  Title: Filter Tree

  Filter tree of the budget execution control segment.
• FilterTreeValue: string
  Title: Filter Summary Value

  Filter tree value of the budget execution control segment.
• FilterTreeVersion: string
  Title: Filter Tree Version

  Filter tree version of the budget execution control segment.
• IsAccountSegment: string
  Default Value: N

  Account segment of the budget execution control segment.
• IsBalancingSegment: string
  Default Value: N

  Balancing segment of the budget execution control segment.
• KeySegmentId: integer (int64)
  Read Only: true

  The unique identifier of the key segment associated with the budget execution control segment.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the record was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Date when the user who last updated the record logged in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SegmentCode: string
  Title: Segment Name

  Segment code of the budget execution control segment.
• SegmentName: string
  Maximum Length: 30

  Segment name of the budget execution control segment.
• SequenceNumber: integer (int32)
  Title: Sequence

  Sequence number of the budget execution control segment.
• SummaryControl: string
  Title: Summary Control

  Summary control of the budget execution control segment.

{
    "type":"object",
    "properties":{
        "ControlBudgetTree":{
            "title":"Tree",
            "type":"string",
            "description":"Control budget tree of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlBudgetTreeLabel":{
            "title":"Tree Label",
            "type":"string",
            "description":"Control budget tree label of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlBudgetTreeVersion":{
            "title":"Tree Version",
            "type":"string",
            "description":"Control budget tree version of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExistsOnParent":{
            "type":"string",
            "description":"Exists on parent attribute of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FilterTree":{
            "title":"Filter Tree",
            "type":"string",
            "description":"Filter tree of the budget execution control segment.",
            "nullable":true,
            "x-queryable":false
        },
        "FilterTreeValue":{
            "title":"Filter Summary Value",
            "type":"string",
            "description":"Filter tree value of the budget execution control segment.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterTreeVersion":{
            "title":"Filter Tree Version",
            "type":"string",
            "description":"Filter tree version of the budget execution control segment.",
            "nullable":true,
            "x-queryable":true
        },
        "IsAccountSegment":{
            "type":"string",
            "description":"Account segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "IsBalancingSegment":{
            "type":"string",
            "description":"Balancing segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "KeySegmentId":{
            "type":"integer",
            "description":"The unique identifier of the key segment associated with the budget execution control segment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Date when the user who last updated the record logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SegmentCode":{
            "title":"Segment Name",
            "type":"string",
            "description":"Segment code of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":30,
            "type":"string",
            "description":"Segment name of the budget execution control segment.",
            "nullable":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the budget execution control segment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "SummaryControl":{
            "title":"Summary Control",
            "type":"string",
            "description":"Summary control of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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