Jump to

• Request
• Response

Update a mapping navigator

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMappingNavigators/{publicSectorMappingNavigatorsUniqID}

Request

Path Parameters

• publicSectorMappingNavigatorsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- MappingName and StepId ---for the Mapping Navigators resource and used to uniquely identify an instance of Mapping Navigators. The client should not generate the hash key value. Instead, the client should query on the Mapping Navigators collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Navigators.
  
  For example: publicSectorMappingNavigators?q=MappingName=<value1>;StepId=<value2>

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeletedFlag: 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.
• Disabled: string
  Maximum Length: 1

  Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.
• MappingName: string
  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• MessageType: string
  Maximum Length: 30

  The type of step message. For example, Confirm and Error.
• ModuleId: 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.
• SeedDataLock: 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: string
  Maximum Length: 512

  Default Value: NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')

  Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.
• StepId: string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited: string
  Maximum Length: 1

  Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.

{
    "type":"object",
    "properties":{
        "Visited":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.",
            "nullable":true
        },
        "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.",
            "nullable":true
        },
        "StepId":{
            "maxLength":"18",
            "type":"string",
            "description":"The unique identifier for the mapping step.",
            "nullable":false
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true,
            "default":"NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')"
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "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.",
            "nullable":true
        },
        "MappingName":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false
        },
        "Disabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.",
            "nullable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step message. For example, Confirm and Error.",
            "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 : publicSectorMappingNavigators-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the field transformation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was created.
• DeletedFlag: 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.
• Disabled: string
  Maximum Length: 1

  Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the field transformation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the field transformation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Maximum Length: 50

  The unique name for the mapping. Mandatory user defined field.
• MessageType: string
  Maximum Length: 30

  The type of step message. For example, Confirm and Error.
• ModuleId: 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.
• SeedDataLock: 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: string
  Maximum Length: 512

  Default Value: NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')

  Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.
• StepId: string
  Maximum Length: 18

  The unique identifier for the mapping step.
• Visited: string
  Maximum Length: 1

  Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Visited":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been visited by the user. Valid values are Y for visited, N for not visited. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the field transformation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the field transformation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "nullable":true,
            "default":"NVL(SYS_CONTEXT('FND_SDF_CTX', 'SDFFILE'), 'SDFFILE')",
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "StepId":{
            "maxLength":"18",
            "type":"string",
            "description":"The unique identifier for the mapping step.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingName":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique name for the mapping. Mandatory user defined field.",
            "nullable":false,
            "x-queryable":true
        },
        "Disabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step has been disabled preventing the user from accessing the step. Valid values are Y for disabled, N for not disabled. Default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step message. For example, Confirm and Error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the field transformation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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