Jump to

• Request
• Response

Create a policy recommendation for a contract

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDeviatingClauses/{Id}/child/ContractPolicyDeviation/{Id2}/child/ContractPolicyRecommendation

Request

Path Parameters

• Id(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=
• Id2(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=
• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• ApprovalAuthority: string
  Maximum Length: 120

  The approval authority of the policy recommendation.
• ApprovalRequiredFlag: boolean
  Maximum Length: 1

  The approval required indicator of the policy recommendation.
• Id: integer (int64)
  The ID of the policy recommendation.
• ObjectVersionNumber: integer (int32)
  The object version number of the policy recommendation.
• PolicyDeviationId: integer (int64)
  The policy deviation ID of the policy recommendation.
• PositionText: string
  Maximum Length: 4000

  The position text of the policy recommendation.
• RecImplementedBy: string
  Maximum Length: 64

  The recommendation implemented by of the policy recommendation.
• RecImplementedFlag: boolean
  Maximum Length: 1

  The recommendation implemented flag of the policy recommendation.
• RecommendationText: string (byte)
  The recommendation text of the policy recommendation.
• RecommendationType: string
  Maximum Length: 32

  The recommendation type of the policy recommendation.
• RecommendationTypeMeaning: string
  Maximum Length: 80

  The recommendation type meaning of the policy recommendation.
• RecommendedBy: string
  Maximum Length: 64

  The recommended by of the policy recommendation.
• RecommendedFlag: boolean
  Maximum Length: 1

  The recommended indicator of the policy recommendation.
• SeverityCode: string
  Maximum Length: 30

  The severity code of the policy recommendation.
• SeverityCodeMeaning: string
  Maximum Length: 80

  The severity code meaning of the policy recommendation.

{
    "type":"object",
    "properties":{
        "ApprovalAuthority":{
            "maxLength":120,
            "type":"string",
            "description":"The approval authority of the policy recommendation.",
            "nullable":true
        },
        "ApprovalRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The approval required indicator of the policy recommendation.",
            "nullable":false
        },
        "Id":{
            "type":"integer",
            "description":"The ID of the policy recommendation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the policy recommendation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PolicyDeviationId":{
            "type":"integer",
            "description":"The policy deviation ID of the policy recommendation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PositionText":{
            "maxLength":4000,
            "type":"string",
            "description":"The position text of the policy recommendation.",
            "nullable":true
        },
        "RecImplementedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The recommendation implemented by of the policy recommendation.",
            "nullable":true
        },
        "RecImplementedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The recommendation implemented flag of the policy recommendation.",
            "nullable":false
        },
        "RecommendationText":{
            "type":"string",
            "description":"The recommendation text of the policy recommendation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RecommendationType":{
            "maxLength":32,
            "type":"string",
            "description":"The recommendation type of the policy recommendation.",
            "nullable":false
        },
        "RecommendationTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The recommendation type meaning of the policy recommendation.",
            "nullable":true,
            "x-queryable":false
        },
        "RecommendedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The recommended by of the policy recommendation.",
            "nullable":true
        },
        "RecommendedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The recommended indicator of the policy recommendation.",
            "nullable":false
        },
        "SeverityCode":{
            "maxLength":30,
            "type":"string",
            "description":"The severity code of the policy recommendation.",
            "nullable":false
        },
        "SeverityCodeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The severity code meaning of the policy recommendation.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : contracts-ContractDeviatingClauses-ContractPolicyDeviation-ContractPolicyRecommendation-item-response

Type: object

Show Source

• ApprovalAuthority: string
  Maximum Length: 120

  The approval authority of the policy recommendation.
• ApprovalRequiredFlag: boolean
  Maximum Length: 1

  The approval required indicator of the policy recommendation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by of the policy recommendation.
• CreationDate: string (date-time)
  Read Only: true

  The creation date of the policy recommendation.
• Id: integer (int64)
  The ID of the policy recommendation.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the policy recommendation.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by of the policy recommendation.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login of the policy recommendation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the policy recommendation.
• PolicyDeviationId: integer (int64)
  The policy deviation ID of the policy recommendation.
• PositionText: string
  Maximum Length: 4000

  The position text of the policy recommendation.
• RecImplementedBy: string
  Maximum Length: 64

  The recommendation implemented by of the policy recommendation.
• RecImplementedFlag: boolean
  Maximum Length: 1

  The recommendation implemented flag of the policy recommendation.
• RecommendationText: string (byte)
  The recommendation text of the policy recommendation.
• RecommendationType: string
  Maximum Length: 32

  The recommendation type of the policy recommendation.
• RecommendationTypeMeaning: string
  Maximum Length: 80

  The recommendation type meaning of the policy recommendation.
• RecommendedBy: string
  Maximum Length: 64

  The recommended by of the policy recommendation.
• RecommendedFlag: boolean
  Maximum Length: 1

  The recommended indicator of the policy recommendation.
• SeverityCode: string
  Maximum Length: 30

  The severity code of the policy recommendation.
• SeverityCodeMeaning: string
  Maximum Length: 80

  The severity code meaning of the policy recommendation.

{
    "type":"object",
    "properties":{
        "ApprovalAuthority":{
            "maxLength":120,
            "type":"string",
            "description":"The approval authority of the policy recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The approval required indicator of the policy recommendation.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by of the policy recommendation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The creation date of the policy recommendation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The ID of the policy recommendation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the policy recommendation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login of the policy recommendation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by of the policy recommendation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the policy recommendation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PolicyDeviationId":{
            "type":"integer",
            "description":"The policy deviation ID of the policy recommendation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PositionText":{
            "maxLength":4000,
            "type":"string",
            "description":"The position text of the policy recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "RecImplementedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The recommendation implemented by of the policy recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "RecImplementedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The recommendation implemented flag of the policy recommendation.",
            "nullable":false,
            "x-queryable":true
        },
        "RecommendationText":{
            "type":"string",
            "description":"The recommendation text of the policy recommendation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RecommendationType":{
            "maxLength":32,
            "type":"string",
            "description":"The recommendation type of the policy recommendation.",
            "nullable":false,
            "x-queryable":true
        },
        "RecommendationTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The recommendation type meaning of the policy recommendation.",
            "nullable":true,
            "x-queryable":false
        },
        "RecommendedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The recommended by of the policy recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The recommended indicator of the policy recommendation.",
            "nullable":false,
            "x-queryable":true
        },
        "SeverityCode":{
            "maxLength":30,
            "type":"string",
            "description":"The severity code of the policy recommendation.",
            "nullable":false,
            "x-queryable":true
        },
        "SeverityCodeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The severity code meaning of the policy recommendation.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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