Jump to

• Request
• Response

Get all communication resources

get

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources

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:
  
  

  • simpleSearchFinder: Finds a communication resource with the specified key word. Finder Variables:
    • value; string; The key word used to find a communication resource such as resource name or resource path.
  • PrimaryKey: Finds a communication resource that matches the specified primary key criteria. Finder Variables:
    • ResourceId; integer; The unique identifier of the communication resource.
  • ResourceCodeAltKey: Finds a communication resource that matches the specified alternate key criteria. Finder Variables:
    • ResourceCode; string; The unique code for the communication resource.
• 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 : publicSectorCommunicationResources

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/publicSectorCommunicationResources-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 publicSectorCommunicationResources-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCommunicationResources-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 : publicSectorCommunicationResources-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the communication resource.
• CommResourceRelations(optional): array Communication Related Resources
  Title: Communication Related Resources

  The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time that the communication resource was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 256

  The description for the communication resource.
• EmEnabled(optional): string
  Maximum Length: 1

  Indicates whether the resource is enabled for use in the business rules framework. The default value is N.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the communication resource is available to be used. The default value is false.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the communication resource was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• OfferingId(optional): string
  Maximum Length: 80

  The offering under which this resource is categorized.
• ResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The unique code for the communication resource.
• ResourceId(optional): integer(int64)
  Title: Resource ID

  The unique identifier of the communication resource. This ID is automatically generated by the application.
• ResourceName(optional): string
  Title: Resource Name

  Maximum Length: 100

  The name of the communication resource.
• ResourcePath(optional): string
  Title: Resource Endpoint

  Maximum Length: 1000

  The communication resource REST endpoint name.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication resource.",
            "title":"Agency ID"
        },
        "CommResourceRelations":{
            "items":{
                "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
            },
            "type":"array",
            "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
            "title":"Communication Related Resources"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication resource.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication resource was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"The description for the communication resource.",
            "title":"Description"
        },
        "EmEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource is enabled for use in the business rules framework. The default value is N."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the communication resource is available to be used. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the communication resource was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication resource.",
            "title":"Last Updated By"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"The offering under which this resource is categorized."
        },
        "ResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique code for the communication resource.",
            "title":"Resource Code"
        },
        "ResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication resource. This ID is automatically generated by the application.",
            "title":"Resource ID"
        },
        "ResourceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the communication resource.",
            "title":"Resource Name"
        },
        "ResourcePath":{
            "maxLength":1000,
            "type":"string",
            "description":"The communication resource REST endpoint name.",
            "title":"Resource Endpoint"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Communication Related Resources

Type: array

Title: Communication Related Resources

The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.

Show Source

• Array of: object publicSectorCommunicationResources-CommResourceRelations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
    },
    "type":"array",
    "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
    "title":"Communication Related Resources"
}

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 : publicSectorCommunicationResources-CommResourceRelations-item

Type: object

Show Source

• AnchorFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the anchor communication resource.
• AnchorFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the anchor communication resource.
• AnchorFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the anchor communication resource.
• AnchorResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The anchor resource code.
• AnchorResourceId(optional): integer(int64)
  The anchor resource identifier.
• AnchorSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the anchor communication resource.
• AnchorThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the anchor communication resource.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RelatedFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the related communication resource.
• RelatedFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the related communication resource.
• RelatedFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the related communication resource.
• RelatedResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The related resource code.
• RelatedResourceId(optional): integer(int64)
  The related resource identifier.
• RelatedSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the related communication resource.
• RelatedThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the related communication resource.
• ResourceRelationCode(optional): string
  Maximum Length: 100

  The unique code for the related communication resource.
• ResourceRelationId(optional): integer(int64)
  The unique identifier for the related communication resource. This is automatically generated by the application.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SeedDataSource(optional): string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "properties":{
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the anchor communication resource."
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the anchor communication resource."
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the anchor communication resource."
        },
        "AnchorResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The anchor resource code.",
            "title":"Resource Code"
        },
        "AnchorResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The anchor resource identifier."
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the anchor communication resource."
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the anchor communication resource."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the related communication resource."
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the related communication resource."
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the related communication resource."
        },
        "RelatedResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The related resource code.",
            "title":"Resource Code"
        },
        "RelatedResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The related resource identifier."
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the related communication resource."
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the related communication resource."
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource."
        },
        "ResourceRelationId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data."
        },
        "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 : 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"
}

Back to Top