Jump to

• Request
• Response

Create

post

/fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates

Request

Path Parameters

• RateScheduleId(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:
  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

• EndDateActive: string (date)
  Title: To Date

  Date after which the rate schedule line is no longer effective.
• JobCode: string
  Title: Code

  Maximum Length: 30

  Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
• JobId: integer (int64)
  Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.
• Rate: number
  Title: Rate

  The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.
• StartDateActive: string (date)
  Title: From Date

  Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"Date after which the rate schedule line is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            }
        },
        "JobCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobId":{
            "type":"integer",
            "description":"Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            }
        }
    }
}

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 : rateSchedules-JobRates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• EndDateActive: string (date)
  Title: To Date

  Date after which the rate schedule line is no longer effective.
• JobCode: string
  Title: Code

  Maximum Length: 30

  Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
• JobId: integer (int64)
  Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.
• JobName: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Name of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Rate: number
  Title: Rate

  The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.
• RateId: integer (int64)
  Read Only: true

  Unique identifier of the rate.
• StartDateActive: string (date)
  Title: From Date

  Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.
• UnitOfMeasureCode: string
  Read Only: true

  Maximum Length: 30

  Unit of measure code associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.
• UnitOfMeasureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Unit of measure associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RateId":{
            "type":"integer",
            "description":"Unique identifier of the rate.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Display",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unit of measure code associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The rate, assigned to the rate schedule line, that's to be applied to calculate the raw cost and revenue amounts. A rate or markup is required to create a rate.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"Date from which the rate schedule line is effective. A start date is required to create a rate. The value can't be updated if the rate is being used.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"Date after which the rate schedule line is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the job to which a rate is defined in the rate schedule. A Job ID or Job Code is required to create a job rate. The value can't be updated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasureName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Unit of measure associated with the resource class in the resource class rate schedule line. A unit of measure is required to create a rate for material items or financial resources and can only be updated if the rate isn't being used.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "JobId":{
            "type":"integer",
            "description":"Identifier of the job for which the rate is entered. A Job ID or Job Code is required to create a job rate. The value can't be updated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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