Jump to

• Request
• Response

Create a rating method

post

/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRatingMethods-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier for the public sector entity to which this rating method applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the rating method was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the rating method.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method.
• links(optional): array Items
  Title: Items

  Link Relations
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• RatingMethodDetail(optional): array Rating Method Details
  Title: Rating Method Details

  The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this rating method applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the rating method was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the rating method.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method.",
            "title":"Last Updated By"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "RatingMethodDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorRatingMethods-RatingMethodDetail-item"
            },
            "type":"array",
            "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
            "title":"Rating Method Details"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Rating Method Details

Type: array

Title: Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Show Source

• Array of: object publicSectorRatingMethods-RatingMethodDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRatingMethods-RatingMethodDetail-item"
    },
    "type":"array",
    "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
    "title":"Rating Method Details"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorRatingMethods-RatingMethodDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this rating range of scores applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the rating method details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating(optional): string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "title":"Minimum Score"
        },
        "Rating":{
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "title":"Rating"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRatingMethods-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier for the public sector entity to which this rating method applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the rating method was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the rating method.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method.
• links(optional): array Items
  Title: Items

  Link Relations
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• RatingMethodDetail(optional): array Rating Method Details
  Title: Rating Method Details

  The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this rating method applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the rating method was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the rating method.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method.",
            "title":"Last Updated By"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "RatingMethodDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorRatingMethods-RatingMethodDetail-item"
            },
            "type":"array",
            "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
            "title":"Rating Method Details"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Rating Method Details

Type: array

Title: Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Show Source

• Array of: object publicSectorRatingMethods-RatingMethodDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRatingMethods-RatingMethodDetail-item"
    },
    "type":"array",
    "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
    "title":"Rating Method Details"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorRatingMethods-RatingMethodDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this rating range of scores applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the rating method details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the rating method details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the rating method details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the rating method details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating(optional): string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod(optional): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the rating method details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "title":"Minimum Score"
        },
        "Rating":{
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "title":"Rating"
        },
        "RatingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "title":"Rating Method"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top