Jump to

• Request
• Response

Update a clause

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause/{ClauseId}

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  The amendment description of the clause.
• ArticleId: integer (int64)
  The clause ID.
• ArticleVersionId: number
  The clause version ID.
• ClauseDescription: string
  Maximum Length: 2000

  The clause description.
• ClauseDisplayTitle: string
  Maximum Length: 450

  The clause display title.
• ClauseTextInHTML: string (byte)
  The clause title in HTML.
• ClauseTitle: string
  Maximum Length: 450

  The clause title.
• ClauseType: string
  The clause type.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  The skip numbering flag.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  The suppress title flag.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The amendment description of the clause.",
            "nullable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"The clause ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"The clause version ID.",
            "nullable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The clause description.",
            "nullable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause display title.",
            "nullable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"The clause title in HTML.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause title.",
            "nullable":false
        },
        "ClauseType":{
            "type":"string",
            "description":"The clause type.",
            "nullable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The skip numbering flag.",
            "nullable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The suppress title flag.",
            "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 : contracts-Section-Clause-item-response

Type: object

Show Source

• AmendmentDescription: string
  Maximum Length: 2000

  The amendment description of the clause.
• ArticleId: integer (int64)
  The clause ID.
• ArticleVersionId: number
  The clause version ID.
• ArticleVersionNumber: integer (int64)
  Read Only: true

  The clause version number.
• ClauseDescription: string
  Maximum Length: 2000

  The clause description.
• ClauseDisplayTitle: string
  Maximum Length: 450

  The clause display title.
• ClauseId: integer (int64)
  Read Only: true

  The unique ID of the clause.
• ClauseLabel: string
  Read Only: true

  Maximum Length: 60

  The clause label.
• ClauseNumber: string
  Read Only: true

  Maximum Length: 240

  The clause number.
• ClauseSection: string
  Read Only: true

  Maximum Length: 300

  The clause section.
• ClauseTextInHTML: string (byte)
  The clause title in HTML.
• ClauseTextInWord: string (byte)
  Read Only: true

  The clause title in Word.
• ClauseTitle: string
  Maximum Length: 450

  The clause title.
• ClauseType: string
  The clause type.
• ContractExpertFlag: boolean
  Read Only: true

  Maximum Length: 1

  The contract expert flag.
• DocumentId: number
  Read Only: true

  The document ID.
• DocumentType: string
  Read Only: true

  Maximum Length: 30

  The document type of the clause.
• HasAlternateFlag: boolean
  Read Only: true

  The indicator of whether the clause has an alternate.
• Id: integer (int64)
  Read Only: true

  The unqiue identifier of the clause.
• IncludeByReferenceFlag: boolean
  Read Only: true

  Maximum Length: 1

  The include by reference flag.
• Instructions: string
  Read Only: true

  Maximum Length: 2000

  The instructions for the clause.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Read Only: true

  The major version associated with the clause.
• MandatoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  The mandatory flag.
• NonstandardFlag: boolean
  Read Only: true

  Maximum Length: 1

  The non standard flag.
• OrgId: integer (int64)
  Read Only: true

  The business unit of the clause.
• ProtectedTextFlag: boolean
  Read Only: true

  Maximum Length: 1

  The protected text flag.
• ScnId: number
  Read Only: true

  The section ID.
• SkipNumberingFlag: boolean
  Maximum Length: 1

  The skip numbering flag.
• SuppressTitleFlag: boolean
  Maximum Length: 1

  The suppress title flag.

{
    "type":"object",
    "properties":{
        "AmendmentDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The amendment description of the clause.",
            "nullable":true,
            "x-queryable":true
        },
        "ArticleId":{
            "type":"integer",
            "description":"The clause ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArticleVersionId":{
            "type":"number",
            "description":"The clause version ID.",
            "nullable":true,
            "x-queryable":true
        },
        "ArticleVersionNumber":{
            "type":"integer",
            "description":"The clause version number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"The clause description.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseDisplayTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause display title.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseId":{
            "type":"integer",
            "description":"The unique ID of the clause.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClauseLabel":{
            "maxLength":60,
            "type":"string",
            "description":"The clause label.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The clause number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseSection":{
            "maxLength":300,
            "type":"string",
            "description":"The clause section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClauseTextInHTML":{
            "type":"string",
            "description":"The clause title in HTML.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ClauseTextInWord":{
            "type":"string",
            "description":"The clause title in Word.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClauseTitle":{
            "maxLength":450,
            "type":"string",
            "description":"The clause title.",
            "nullable":false,
            "x-queryable":true
        },
        "ClauseType":{
            "type":"string",
            "description":"The clause type.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractExpertFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The contract expert flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"number",
            "description":"The document ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":30,
            "type":"string",
            "description":"The document type of the clause.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasAlternateFlag":{
            "type":"boolean",
            "description":"The indicator of whether the clause has an alternate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unqiue identifier of the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeByReferenceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The include by reference flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Instructions":{
            "maxLength":2000,
            "type":"string",
            "description":"The instructions for the clause.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The major version associated with the clause.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonstandardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The non standard flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The business unit of the clause.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProtectedTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The protected text flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScnId":{
            "type":"number",
            "description":"The section ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipNumberingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The skip numbering flag.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressTitleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The suppress title flag.",
            "nullable":true,
            "x-queryable":true
        },
        "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