Jump to

• Request
• Response

Update a transaction type for a terms of use definition

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage/{TermsUsageUniqID}

Request

Supported Media Types

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

Path Parameters

• TermsUsageUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, TermsUseId, EffectiveStartDate, EffectiveEndDate and Product ---for the Terms Usages resource and used to uniquely identify an instance of Terms Usages. The client should not generate the hash key value. Instead, the client should query on the Terms Usages collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Usages.
  
  For example: TermsUsage?q=AgencyId=<value1>;TermsUseId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;Product=<value5>
• publicSectorTermsOfUsesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, TermsUseId, EffectiveStartDate and EffectiveEndDate ---for the Terms Of Use Definitions resource and used to uniquely identify an instance of Terms Of Use Definitions. The client should not generate the hash key value. Instead, the client should query on the Terms Of Use Definitions collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Of Use Definitions.
  
  For example: publicSectorTermsOfUses?q=AgencyId=<value1>;TermsUseId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>

Body ()

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

Root Schema : publicSectorTermsOfUses-TermsUsage-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(optional): string(date)
  The effective end date of the terms of use definition.
• EffectiveStartDate(optional): string(date)
  The effective start date of the terms of use definition.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.
• links(optional): array Items
  Title: Items

  Link Relations
• Product(optional): string
  Maximum Length: 30

  The transaction type for which the terms content is enabled or disabled.
• TermsUseId(optional): string
  Maximum Length: 15

  The unique identifier for a terms of use definition.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "type":"integer",
            "format":"int32"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the terms of use definition.",
            "type":"string",
            "maxLength":100
        },
        "EffectiveEndDate":{
            "description":"The effective end date of the terms of use definition.",
            "type":"string",
            "format":"date"
        },
        "EffectiveStartDate":{
            "description":"The effective start date of the terms of use definition.",
            "type":"string",
            "format":"date"
        },
        "EnabledFlag":{
            "description":"Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "Product":{
            "description":"The transaction type for which the terms content is enabled or disabled.",
            "type":"string",
            "maxLength":30
        },
        "TermsUseId":{
            "description":"The unique identifier for a terms of use definition.",
            "type":"string",
            "maxLength":15
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorTermsOfUses-TermsUsage-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(optional): string(date)
  The effective end date of the terms of use definition.
• EffectiveStartDate(optional): string(date)
  The effective start date of the terms of use definition.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.
• links(optional): array Items
  Title: Items

  Link Relations
• Product(optional): string
  Maximum Length: 30

  The transaction type for which the terms content is enabled or disabled.
• TermsUseId(optional): string
  Maximum Length: 15

  The unique identifier for a terms of use definition.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "type":"integer",
            "format":"int32"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the terms of use definition.",
            "type":"string",
            "maxLength":100
        },
        "EffectiveEndDate":{
            "description":"The effective end date of the terms of use definition.",
            "type":"string",
            "format":"date"
        },
        "EffectiveStartDate":{
            "description":"The effective start date of the terms of use definition.",
            "type":"string",
            "format":"date"
        },
        "EnabledFlag":{
            "description":"Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.",
            "type":"string",
            "maxLength":1
        },
        "Product":{
            "description":"The transaction type for which the terms content is enabled or disabled.",
            "type":"string",
            "maxLength":30
        },
        "TermsUseId":{
            "description":"The unique identifier for a terms of use definition.",
            "type":"string",
            "maxLength":15
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top