Jump to

• Request
• Response

Create a set of fee line mappings

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineMaps

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency to which this fee line map is belongs.
• AppSource: string
  Maximum Length: 30

  Indicates the source of fee mapping.
• EffectiveEndDate: string (date)
  The start date of the fee line mapping.
• EffectiveStartDate: string (date)
  The end date of the fee line mapping.
• FeeScheduleId: string
  Title: Fee Schedule

  Maximum Length: 20

  The unique name that identifies a fee schedule.
• FeeScheduleLine: integer
  Title: Fee Items

  The line number for the current fee schedule.
• FieldNumber: integer
  The field number for the fee line mapping.
• LayoutVersion: string
  Maximum Length: 30

  The version ID assigned to this specific layout.
• MappingType: string
  Maximum Length: 10

  The type of mapping on the page. The list of values are IN for input and OUT for output.
• RecordTypeId: string
  Maximum Length: 30

  The unique name that identifies a record type.
• SourceFieldname: string
  Maximum Length: 50

  The fieldname from the decision model associated with the fee line. It can be either a decision model input fieldname or output fieldname.
• SourceFieldtype: string
  Maximum Length: 30

  The data type of the decision model input or output field.
• SourceLabel: string
  Maximum Length: 200

  A user-friendly source name. For decision models, this is the same as the SourceFieldname.
• SourceObjectname: string
  Maximum Length: 200

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

  The fieldname from one of the application fields.
• TargetLabel: string
  Maximum Length: 200

  A user-friendly target fieldname.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.
• TargetResourceName: string
  Maximum Length: 200

  The resource name of the target's parent object.

{
    "type":"object",
    "properties":{
        "MappingType":{
            "maxLength":"10",
            "type":"string",
            "description":"The type of mapping on the page. The list of values are IN for input and OUT for output.",
            "nullable":false
        },
        "SourceObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee line map is belongs.",
            "nullable":false,
            "default":"1"
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The start date of the fee line mapping.",
            "format":"date",
            "nullable":true
        },
        "LayoutVersion":{
            "maxLength":"30",
            "type":"string",
            "description":"The version ID assigned to this specific layout.",
            "nullable":true
        },
        "FeeScheduleLine":{
            "title":"Fee Items",
            "type":"integer",
            "description":"The line number for the current fee schedule.",
            "nullable":false
        },
        "AppSource":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the source of fee mapping.",
            "nullable":true
        },
        "FieldNumber":{
            "type":"integer",
            "description":"The field number for the fee line mapping.",
            "nullable":false
        },
        "SourceLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"A user-friendly source name. For decision models, this is the same as the SourceFieldname.",
            "nullable":true
        },
        "TargetLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"A user-friendly target fieldname.",
            "nullable":true
        },
        "SourceFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The fieldname from the decision model associated with the fee line. It can be either a decision model input fieldname or output fieldname.",
            "nullable":true
        },
        "TargetFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The fieldname from one of the application fields.",
            "nullable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies a record type.",
            "nullable":false
        },
        "SourceFieldtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The data type of the decision model input or output field.",
            "nullable":true
        },
        "FeeScheduleId":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"The unique name that identifies a fee schedule.",
            "nullable":false
        },
        "TargetResourceName":{
            "maxLength":"200",
            "type":"string",
            "description":"The resource name of the target's parent object.",
            "nullable":true
        },
        "TargetObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The end date of the fee line mapping.",
            "format":"date",
            "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 : publicSectorFeeLineMaps-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency to which this fee line map is belongs.
• AppSource: string
  Maximum Length: 30

  Indicates the source of fee mapping.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The date when the fee line map was last updated.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The user who last updated the fee line mapping.
• EffectiveEndDate: string (date)
  The start date of the fee line mapping.
• EffectiveStartDate: string (date)
  The end date of the fee line mapping.
• FeeScheduleId: string
  Title: Fee Schedule

  Maximum Length: 20

  The unique name that identifies a fee schedule.
• FeeScheduleLine: integer
  Title: Fee Items

  The line number for the current fee schedule.
• FieldNumber: integer
  The field number for the fee line mapping.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the fee line mapping was created.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the fee line mapping.
• LayoutVersion: string
  Maximum Length: 30

  The version ID assigned to this specific layout.
• links: array Links
  Title: Links

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

  The type of mapping on the page. The list of values are IN for input and OUT for output.
• RecordTypeId: string
  Maximum Length: 30

  The unique name that identifies a record type.
• SourceFieldname: string
  Maximum Length: 50

  The fieldname from the decision model associated with the fee line. It can be either a decision model input fieldname or output fieldname.
• SourceFieldtype: string
  Maximum Length: 30

  The data type of the decision model input or output field.
• SourceLabel: string
  Maximum Length: 200

  A user-friendly source name. For decision models, this is the same as the SourceFieldname.
• SourceObjectname: string
  Maximum Length: 200

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

  The fieldname from one of the application fields.
• TargetLabel: string
  Maximum Length: 200

  A user-friendly target fieldname.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.
• TargetResourceName: string
  Maximum Length: 200

  The resource name of the target's parent object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the fee line mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingType":{
            "maxLength":"10",
            "type":"string",
            "description":"The type of mapping on the page. The list of values are IN for input and OUT for output.",
            "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":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who last updated the fee line mapping.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the fee line map was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee line map is belongs.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The start date of the fee line mapping.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":"30",
            "type":"string",
            "description":"The version ID assigned to this specific layout.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "title":"Fee Items",
            "type":"integer",
            "description":"The line number for the current fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "AppSource":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the source of fee mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldNumber":{
            "type":"integer",
            "description":"The field number for the fee line mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"A user-friendly source name. For decision models, this is the same as the SourceFieldname.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"A user-friendly target fieldname.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The fieldname from the decision model associated with the fee line. It can be either a decision model input fieldname or output fieldname.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The fieldname from one of the application fields.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique name that identifies a record type.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceFieldtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The data type of the decision model input or output field.",
            "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":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"The unique name that identifies a fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetResourceName":{
            "maxLength":"200",
            "type":"string",
            "description":"The resource name of the target's parent object.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The end date of the fee line mapping.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the fee line mapping was created.",
            "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