Jump to

• Request
• Response

Update a fee schedule map

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD/{FeeScheduleMapDUniqID}

Request

Path Parameters

• FeeLineUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate, EffectiveEndDate and FeeScheduleLine ---for the Fee Lines resource and used to uniquely identify an instance of Fee Lines. The client should not generate the hash key value. Instead, the client should query on the Fee Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Lines.
  
  For example: FeeLine?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;FeeScheduleLine=<value5>
• FeeScheduleMapDUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, EffectiveEndDate, EffectiveStartDate, FeeScheduleId, FeeScheduleLine, FieldNum and MappingType ---for the Fee Schedule Map Data resource and used to uniquely identify an instance of Fee Schedule Map Data. The client should not generate the hash key value. Instead, the client should query on the Fee Schedule Map Data collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Schedule Map Data.
  
  For example: FeeScheduleMapD?q=AgencyId=<value1>;EffectiveEndDate=<value2>;EffectiveStartDate=<value3>;FeeScheduleId=<value4>;FeeScheduleLine=<value5>;FieldNum=<value6>;MappingType=<value7>
• publicSectorFeeSchedulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate and EffectiveEndDate ---for the Fee Schedules resource and used to uniquely identify an instance of Fee Schedules. The client should not generate the hash key value. Instead, the client should query on the Fee Schedules collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Schedules.
  
  For example: publicSectorFeeSchedules?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>

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

• EffectiveEndDate: string (date)
  The end date of the fee schedule map.
• EffectiveStartDate: string (date)
  The start date of the fee schedule map.
• SourceFieldname: string
  Maximum Length: 50

  The DMN input field name.
• SourceFieldtype: string
  Maximum Length: 30

  The data type of the DMN input field name.
• SourceLabel: string
  Maximum Length: 200

  The label for the DMN input field name.
• SourceObjectname: string
  Maximum Length: 200

  The name of the source business object for an array.
• TargetFieldname: string
  Maximum Length: 50

  This field name in the transaction table that contains the DMN input value.
• TargetLabel: string
  Maximum Length: 200

  The label for the target field name.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.

{
    "type":"object",
    "properties":{
        "SourceLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the DMN input field name.",
            "nullable":true
        },
        "SourceObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule map.",
            "format":"date",
            "nullable":false
        },
        "TargetLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the target field name.",
            "nullable":true
        },
        "SourceFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The DMN input field name.",
            "nullable":true
        },
        "TargetFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"This field name in the transaction table that contains the DMN input value.",
            "nullable":true
        },
        "SourceFieldtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The data type of the DMN input field name.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule map.",
            "format":"date",
            "nullable":false
        },
        "TargetObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true
        }
    }
}

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 : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response

Type: object

Show Source

• AgencyId: integer
  The identifier for the public sector agency to which this fee schedule map belongs.
• CreationDate: string (date-time)
  Read Only: true

  The date when the fee schedule map was created.
• EffectiveEndDate: string (date)
  The end date of the fee schedule map.
• EffectiveStartDate: string (date)
  The start date of the fee schedule map.
• FeeScheduleId: string
  Maximum Length: 20

  A unique name that identifies a fee schedule.
• FeeScheduleLine: integer
  The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
• FieldNum: integer
  The sequence number for the field in the mapping table.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the fee schedule map was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingType: string
  Maximum Length: 10

  The identifier to distinguish between the IN and OUT mapping.
• SourceFieldname: string
  Maximum Length: 50

  The DMN input field name.
• SourceFieldtype: string
  Maximum Length: 30

  The data type of the DMN input field name.
• SourceLabel: string
  Maximum Length: 200

  The label for the DMN input field name.
• SourceObjectname: string
  Maximum Length: 200

  The name of the source business object for an array.
• TargetFieldname: string
  Maximum Length: 50

  This field name in the transaction table that contains the DMN input value.
• TargetLabel: string
  Maximum Length: 200

  The label for the target field name.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.

{
    "type":"object",
    "properties":{
        "MappingType":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier to distinguish between the IN and OUT mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the fee schedule map was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee schedule map belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule map.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldNum":{
            "type":"integer",
            "description":"The sequence number for the field in the mapping table.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the target field name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"This field name in the transaction table that contains the DMN input value.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The data type of the DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "maxLength":"20",
            "type":"string",
            "description":"A unique name that identifies a fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule map.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the fee schedule map 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