Jump to

• Request
• Response

Get all scope configurations

get

/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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:
  
  

  • PrimaryKey: Finds the scope configuration that matches the specified scope configuration ID.
    Finder Variables:
    • ScopeConfigId; string; The unique identifier of the scope configuration.
  • simpleSearchFinder: Finds the scope configuration that matches the specified scope configuration ID, description, view object name, or business object name.
    Finder Variables:
    • value; string; Finds the scope configuration that matches the specified scope configuration ID, description, view object name, or business object name.
• 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.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AltKeyName; string; The alternate identifier name of the scope configuration setup data.
  • BoName; string; The name of the business object in the scope configuration setup data.
  • DefaultScope; string; Indicates the default scope that will be applied to the business object during export.
  • DeletedFlag; string; Indicates the deleted status of the scope configuration setup.
  • EffdtMigrationMode; string; Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode.
  • ParentBoName; string; The name of the parent business object in the scope configuration setup data.
  • RowIdentifier; string; The row identifier in the data XML.
  • ScopeConfigDescr; string; The description about the scope configuration setup.
  • ScopeConfigId; string; The unique identifier of the scope configuration setup.
  • SeedDataLock; integer; Indicates the seed data lock status of the scope configuration setup.
  • ServiceLabel; string; The label of the Scope Selection page.
  • ServiceName; string; The name of the data service in the scope configuration setup.
  • VoName; string; The name of the view object in the scope configuration setup data.
• 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".

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.

There's no request body for this operation.

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 : publicSectorScopeConfigurations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorScopeConfigurations-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorScopeConfigurations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorScopeConfigurations-item-response"
    }
}

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 : publicSectorScopeConfigurations-item-response

Type: object

Show Source

• AltKeyName: string
  Title: Alternate Key Name

  Maximum Length: 100

  The alternate identifier name of the scope configuration setup data.
• BoName: string
  Title: Business Object

  Maximum Length: 255

  The name of the business object in the scope configuration setup data.
• DefaultScope: string
  Maximum Length: 1000

  Indicates the default scope that will be applied to the business object during export.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates the deleted status of the scope configuration setup.
• EffdtMigrationMode: string
  Maximum Length: 8

  Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentBoName: string
  Title: Parent Business Object

  Maximum Length: 255

  The name of the parent business object in the scope configuration setup data.
• RowIdentifier: string
  Maximum Length: 60

  The row identifier in the data XML.
• ScopeConfigDescr: string
  Title: Description

  Maximum Length: 100

  The description about the scope configuration setup.
• ScopeConfigId: string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeConfigurationField: array Scope Configuration Fields
  Title: Scope Configuration Fields

  The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the seed data lock status of the scope configuration setup.
• ServiceLabel: string
  Title: Service Label

  Maximum Length: 255

  The label of the Scope Selection page.
• ServiceName: string
  Title: Service Name

  Maximum Length: 100

  The name of the data service in the scope configuration setup.
• VoName: string
  Title: View Object Name

  Maximum Length: 100

  The name of the view object in the scope configuration setup data.

{
    "type":"object",
    "properties":{
        "AltKeyName":{
            "title":"Alternate Key Name",
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier name of the scope configuration setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "BoName":{
            "title":"Business Object",
            "maxLength":255,
            "type":"string",
            "description":"The name of the business object in the scope configuration setup data.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultScope":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the default scope that will be applied to the business object during export.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration setup.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "EffdtMigrationMode":{
            "maxLength":8,
            "type":"string",
            "description":"Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentBoName":{
            "title":"Parent Business Object",
            "maxLength":255,
            "type":"string",
            "description":"The name of the parent business object in the scope configuration setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "RowIdentifier":{
            "maxLength":60,
            "type":"string",
            "description":"The row identifier in the data XML.",
            "nullable":true,
            "x-queryable":true
        },
        "ScopeConfigDescr":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description about the scope configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "ScopeConfigId":{
            "title":"Scope Configuration ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "ScopeConfigurationField":{
            "title":"Scope Configuration Fields",
            "type":"array",
            "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
            "items":{
                "$ref":"#/components/schemas/publicSectorScopeConfigurations-ScopeConfigurationField-item-response"
            }
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ServiceLabel":{
            "title":"Service Label",
            "maxLength":255,
            "type":"string",
            "description":"The label of the Scope Selection page.",
            "nullable":false,
            "x-queryable":true
        },
        "ServiceName":{
            "title":"Service Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the data service in the scope configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "VoName":{
            "title":"View Object Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the view object in the scope configuration setup data.",
            "nullable":false,
            "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 : Scope Configuration Fields

Type: array

Title: Scope Configuration Fields

The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.

Show Source

• Array of: object publicSectorScopeConfigurations-ScopeConfigurationField-item-response

{
    "title":"Scope Configuration Fields",
    "type":"array",
    "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
    "items":{
        "$ref":"#/components/schemas/publicSectorScopeConfigurations-ScopeConfigurationField-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item-response

Type: object

Show Source

• AltKeyAttrb: string
  Title: Alternate Key Field

  Maximum Length: 100

  The alternative unique identifier of the scope configuration setup data.
• AltKeyReference: string
  Title: Reference Business Object

  Maximum Length: 50

  The name of the reference attribute for the alternate attribute in the scope configuration field setup data.
• AutoKeyFlag: boolean
  Title: Surrogate Field

  Maximum Length: 1

  The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates the deleted status of the scope configuration field setup.
• FieldLabelString: string
  Title: Label String Key

  Maximum Length: 160

  The attribute label string that is displayed on the Scope Selection page.
• FieldName: string
  Title: Field Name

  Maximum Length: 100

  The attribute name of the scope configuration field setup data.
• FieldType: string
  Title: Field Type

  Maximum Length: 20

  The attribute type of the scope configuration field setup data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReturnToFsmFlag: boolean
  Title: Return to Functional Setup Manager

  Maximum Length: 1

  The attribute to determine whether the field value is used as a scope for data filtration.
• ScopeConfigId: string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeFieldId: string
  Title: Field ID

  Maximum Length: 12

  The unique identifier of the scope configuration field setup.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the seed data lock status of the scope configuration setup.

{
    "type":"object",
    "properties":{
        "AltKeyAttrb":{
            "title":"Alternate Key Field",
            "maxLength":100,
            "type":"string",
            "description":"The alternative unique identifier of the scope configuration setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "AltKeyReference":{
            "title":"Reference Business Object",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reference attribute for the alternate attribute in the scope configuration field setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoKeyFlag":{
            "title":"Surrogate Field",
            "maxLength":1,
            "type":"boolean",
            "description":"The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration field setup.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "FieldLabelString":{
            "title":"Label String Key",
            "maxLength":160,
            "type":"string",
            "description":"The attribute label string that is displayed on the Scope Selection page.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":100,
            "type":"string",
            "description":"The attribute name of the scope configuration field setup data.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldType":{
            "title":"Field Type",
            "maxLength":20,
            "type":"string",
            "description":"The attribute type of the scope configuration field setup data.",
            "nullable":false,
            "x-queryable":true
        },
        "ReturnToFsmFlag":{
            "title":"Return to Functional Setup Manager",
            "maxLength":1,
            "type":"boolean",
            "description":"The attribute to determine whether the field value is used as a scope for data filtration.",
            "nullable":false,
            "x-queryable":true
        },
        "ScopeConfigId":{
            "title":"Scope Configuration ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "ScopeFieldId":{
            "title":"Field ID",
            "maxLength":12,
            "type":"string",
            "description":"The unique identifier of the scope configuration field setup.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "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"
    }
}

Back to Top