Jump to

• Request
• Response

Get all terms of use definitions

get

/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • termsUseFinder: Finds the terms of use definition that matches the terms of use ID specified. Finder Variables:
    • EffectiveEndDate; string; The effective start date for a terms of use definition.
    • EffectiveStartDate; string; The effective end date for a terms of use definition.
    • TermsUseId; string; The unique identifier for a terms of use definition.
  • PrimaryKey: Finds the terms of use definition that matches the the primary key specified. Finder Variables:
    • AgencyId; integer; The agency ID for a terms of use definition.
    • EffectiveEndDate; string; The effective end date for a terms of use definition.
    • EffectiveStartDate; string; The effective start date for a terms of use definition.
    • TermsUseId; string; The unique identifier for a terms of use definition.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorTermsOfUses

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorTermsOfUses-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorTermsOfUses-item

{
    "items":{
        "$ref":"#/definitions/publicSectorTermsOfUses-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorTermsOfUses-item

Type: object

Show Source

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

  The user who created the terms of use definition.
• CreationDate(optional): string(date-time)
  The date and time that the terms of use definition was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The effective end date of the terms of use definition.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The effective start date of the terms of use definition.
• LastUpdateDate(optional): string(date-time)
  The date and time when the terms of use definition was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the terms of use definition.
• links(optional): array Items
  Title: Items

  Link Relations
• TermsContent(optional): string
  Title: Content

  The detailed content of the terms of use.
• TermsUsage(optional): array Terms Usages
  Title: Terms Usages

  The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.
• TermsUseId(optional): string
  Title: Terms of Use ID

  Maximum Length: 15

  The unique identifier for the terms of use definition.
• UseBusLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N.
• UsePermitting(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N.
• UsePlanning(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N.
• UsePolLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N.
• UseRegistration(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the terms of use definition."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the terms of use definition was created."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition.",
            "title":"Description"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the terms of use definition.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the terms of use definition.",
            "title":"Effective Start Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the terms of use definition was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the terms of use definition."
        },
        "TermsContent":{
            "type":"string",
            "description":"The detailed content of the terms of use.",
            "title":"Content"
        },
        "TermsUsage":{
            "items":{
                "$ref":"#/definitions/publicSectorTermsOfUses-TermsUsage-item"
            },
            "type":"array",
            "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
            "title":"Terms Usages"
        },
        "TermsUseId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the terms of use definition.",
            "title":"Terms of Use ID"
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N."
        },
        "UseRegistration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N."
        },
        "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 : Terms Usages

Type: array

Title: Terms Usages

The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.

Show Source

• Array of: object publicSectorTermsOfUses-TermsUsage-item

{
    "items":{
        "$ref":"#/definitions/publicSectorTermsOfUses-TermsUsage-item"
    },
    "type":"array",
    "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
    "title":"Terms Usages"
}

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 : 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.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who added the transaction type to the terms of use definition.
• CreationDate(optional): string(date-time)
  The date and time that the transaction type was added to the 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.
• LastUpdateDate(optional): string(date-time)
  The date and time that the transaction type was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the transaction type.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who added the transaction type to the terms of use definition."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the transaction type was added to the terms of use definition."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition.",
            "title":"Description"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the terms of use definition."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the terms of use definition."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "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."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the transaction type was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the transaction type."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "Product":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for which the terms content is enabled or disabled."
        },
        "TermsUseId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a terms of use definition."
        },
        "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