Jump to

• Request
• Response

Update a fee list structure

patch

/fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}

Request

Path Parameters

• FeeGroupId(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=
• FeeGroupStructureId(required): integer
  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:
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the fee group structure.
• Name(required): string
  Title: Name

  Maximum Length: 50

  Name of the fee group structure.
• ParentFeeGroupStructureId: integer
  Title: Parent Fee Item ID

  Parent fee of a fee in a fee group.
• Sequence(required): integer
  Title: Fee List Sequence

  Sequence number of the fee group structure.
• structureDetails: array Structure Details
  Title: Structure Details

  Details about the fee group structure, such as name and description.

{
    "required":[
        "Name",
        "Sequence"
    ],
    "type":"object",
    "properties":{
        "structureDetails":{
            "title":"Structure Details",
            "type":"array",
            "description":"Details about the fee group structure, such as name and description.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the fee group structure.",
            "nullable":true
        },
        "ParentFeeGroupStructureId":{
            "title":"Parent Fee Item ID",
            "type":"integer",
            "description":"Parent fee of a fee in a fee group.",
            "nullable":true
        },
        "Sequence":{
            "title":"Fee List Sequence",
            "type":"integer",
            "description":"Sequence number of the fee group structure.",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee group structure.",
            "nullable":false
        }
    }
}

Nested Schema : Structure Details

Type: array

Title: Structure Details

Details about the fee group structure, such as name and description.

Show Source

• Array of: object schema

{
    "title":"Structure Details",
    "type":"array",
    "description":"Details about the fee group structure, such as name and description.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Sequence: integer
  Title: Structure Detail Sequence

  Sequence number of the fee item within a fee group.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 30

  Code of the source object.
• SourceObjectId: integer
  Title: Source Object ID

  Unique identifier of the source object detail.

{
    "type":"object",
    "properties":{
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"Unique identifier of the source object detail.",
            "nullable":false
        },
        "Sequence":{
            "title":"Structure Detail Sequence",
            "type":"integer",
            "description":"Sequence number of the fee item within a fee group.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : feeGroups-feeGroupStructures-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the fee group structure.
• FeeGroupStructureId: integer
  Title: Fee List Structure ID

  Read Only: true

  Unique identifier of the fee group structure.
• links: array Links
  Title: Links

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

  Maximum Length: 50

  Name of the fee group structure.
• ParentFeeGroupStructureId: integer
  Title: Parent Fee Item ID

  Parent fee of a fee in a fee group.
• Sequence: integer
  Title: Fee List Sequence

  Sequence number of the fee group structure.
• structureDetails: array Structure Details
  Title: Structure Details

  Details about the fee group structure, such as name and description.

{
    "type":"object",
    "properties":{
        "structureDetails":{
            "title":"Structure Details",
            "type":"array",
            "description":"Details about the fee group structure, such as name and description.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the fee group structure.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentFeeGroupStructureId":{
            "title":"Parent Fee Item ID",
            "type":"integer",
            "description":"Parent fee of a fee in a fee group.",
            "nullable":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Fee List Sequence",
            "type":"integer",
            "description":"Sequence number of the fee group structure.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeGroupStructureId":{
            "title":"Fee List Structure ID",
            "type":"integer",
            "description":"Unique identifier of the fee group structure.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee group structure.",
            "nullable":false,
            "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 : Structure Details

Type: array

Title: Structure Details

Details about the fee group structure, such as name and description.

Show Source

• Array of: object feeGroups-feeGroupStructures-structureDetails-item-response

{
    "title":"Structure Details",
    "type":"array",
    "description":"Details about the fee group structure, such as name and description.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : feeGroups-feeGroupStructures-structureDetails-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer
  Title: Structure Detail Sequence

  Sequence number of the fee item within a fee group.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 30

  Code of the source object.
• SourceObjectId: integer
  Title: Source Object ID

  Unique identifier of the source object detail.
• SourceObjectMeaning: string
  Title: Source Object Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the source object.
• StructureDetailId: integer
  Title: Fee Structure Detail ID

  Read Only: true

  Unique identifier of the fee group structure detail.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"Unique identifier of the source object detail.",
            "nullable":false,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Structure Detail Sequence",
            "type":"integer",
            "description":"Sequence number of the fee item within a fee group.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Source Object Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureDetailId":{
            "title":"Fee Structure Detail ID",
            "type":"integer",
            "description":"Unique identifier of the fee group structure detail.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Links

structureDetails

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures/{FeeGroupStructureId}/child/structureDetails

Parameters:

• FeeGroupId: $request.path.FeeGroupId
• FeeGroupStructureId: $request.path.FeeGroupStructureId

Details about the fee group structure, such as name and description.

Back to Top